Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] Numbered list #1761

Closed
annieappflowy opened this issue Jan 30, 2023 · 16 comments
Closed

[Bug] Numbered list #1761

annieappflowy opened this issue Jan 30, 2023 · 16 comments
Assignees
Labels
documentation Improvements or additions to documentation editor features related to the rich-text editor good first issue for devs for the community members to claim shortcuts features related to keyboard shortcuts

Comments

@annieappflowy
Copy link
Collaborator

Bug Description

No line between numbered list items is allowed

image

How to Reproduce

  1. Create three numbered list items
  2. Try to add an empty line between 1. and 2.
  3. The numbers shown are not incremental from 1 to 3

Expected Behavior

Like Google Docs, I can add empty lines in between a numbered list
image

Operating System

Windows 10

AppFlowy Version(s)

0.0.9.1

Screenshots

No response

Additional Context

No response

@LucasXu0
Copy link
Collaborator

It's by design. If we press the enter between numbered lists, the below part will re-sort from 1.

Please take a look at this video if you'd like to insert an empty line between the incremental numbered list.

demo.mov

Or using shift+enter to add a new line at the same node.

@richardshiue
Copy link
Collaborator

richardshiue commented Jan 31, 2023

I didn't know about shift+enter, maybe that's what Annie wants. In google docs, the shift+enter to add a new line in the same node is a single enter followed a backspace, and a subsequent enter/backspace will trigger AppFlowy's usual backspace behavior that splits the number list into two.

@annieappflowy
Copy link
Collaborator Author

Ok I see. I didn't figure out the trick.
I suppose Shift + enter should be added to our shortcuts guide (which doesn't exist yet)

@annieappflowy annieappflowy added documentation Improvements or additions to documentation editor features related to the rich-text editor shortcuts features related to keyboard shortcuts labels Jan 31, 2023
@MayurSMahajan
Copy link
Collaborator

Okay, so we just want to add documentation for the shift+enter, in our shortcuts guide(which I will be happy to make), right? Or am I missing something? I did not understand what Richard meant.

@annieappflowy
Copy link
Collaborator Author

Based on my understanding, what Richard means is that in Google Docs both ways (shift+enter or enter+backspace) can achieve adding lines between numbered item without breaking the existing number order. AppFlowy only supports shift+enter at the moment.

I think we should write documentation to list out all the shortcuts we support. In addition, we can add an entry to the "?" list at the bottom right of the editing area to direct users to view the shortcut guide.

@MayurSMahajan
Copy link
Collaborator

Okay understood! Thanks.

@MayurSMahajan
Copy link
Collaborator

So the objective of the PR solving this issue will facilitate the redirection of the user to a documentation page that enlists all the existing predefined shortcuts. This link can be accessed by clicking on the "?" button
image
I can get this done, but this seems a perfect choice for a "good first issue" for any newcomers. If no one claims it I will work on it.

@MayurSMahajan MayurSMahajan added the good first issue for devs for the community members to claim label Feb 1, 2023
@AmanNegi
Copy link
Contributor

Hey there can I work on this?

@MayurSMahajan
Copy link
Collaborator

Hey @AmanNegi! Go ahead, you can start working on this.

@AmanNegi
Copy link
Contributor

Hey there, do we already have a list of Shortcuts listed somewhere? If not are we supposed to create a Flutter Page or a SHORTCUTS.md in the GitHub Repository?

@annieappflowy
Copy link
Collaborator Author

Hi @AmanNegi , we should create a documentation page to list the shortcuts we support and build a link in the app so people can be directed to that page.

Just created a page for you to fill good stuff in: https://github.com/AppFlowy-IO/AppFlowy-Docs/blob/main/essential-documentation/shortcuts.md
You can work on it and submit a PR for review.
Meanwhile, you can also work on adding a link to "?"

@MayurSMahajan
Copy link
Collaborator

Hey @AmanNegi, you can find the list of existing shortcuts here.
AppFlowy\frontend\app_flowy\packages\appflowy_editor\lib\src\service\shortcut_event\built_in_shortcut_events.dart

@AmanNegi
Copy link
Contributor

Thanks, 😊 @MayurSMahajan That helps a lot!

@AmanNegi
Copy link
Contributor

AmanNegi commented Feb 17, 2023

Hey there, I had a question. If I add some text, do I need to add translation in each language?

  "questionBubble": {
    "shortcuts": "Shortcuts", 
    "whatsNew": "What's new?", 
    "help": "Help & Support",
    "debug": {
      "name": "Debug Info",
      "success": "Copied debug info to clipboard!",
      "fail": "Unable to copy debug info to clipboard"
    }
  }

Added "shortcuts": "Shortcuts" above in en.json.

PS: I have added all the shortcuts and made a PR here.

@MayurSMahajan
Copy link
Collaborator

No just English is fine, if you want to add a translation for any other language, you can create a new PR for that.

@AmanNegi
Copy link
Contributor

Okay great :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation editor features related to the rich-text editor good first issue for devs for the community members to claim shortcuts features related to keyboard shortcuts
Projects
Status: Done
Development

No branches or pull requests

5 participants