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

Inline non-unicode image support (icons and emojis) #8

Closed
10 tasks
bk-one opened this issue Jan 5, 2021 · 1 comment
Closed
10 tasks

Inline non-unicode image support (icons and emojis) #8

bk-one opened this issue Jan 5, 2021 · 1 comment
Labels
area_infrastructure Pertains to cross-cutting infrastructure customer_superlist Needed by Superlist status_needs_analysis A maintainer needs to break down this ticket into action items. type_product_feature Describes a product capability rather than an actionable Super Editor capability.
Milestone

Comments

@bk-one
Copy link
Contributor

bk-one commented Jan 5, 2021

Context of use: Usage of Inline non-unicode icons and emojis
Primary Actor: User
Triggers: User enters special characters colon character followed by a sequence of at least two character

Main Success Scenario:

  • 1. The user clicks on the content section to get into editing mode
  • 2. The cursor appears at the position where the user clicked
  • 3. The user starts typing the characters ":" + "fire" + ":" (written as three strings in the ticket, as GH will render an icon otherwise - 🔥)
  • 4. The entered text is replaced with the fire icon (see screenshot, find the icon in Figma)
  • 5. The fire icon is displayed in-line at the place where the text was entered. The size of the icon is automatically adjusted to the current font size, so the bottom of the icon is on the baseline and the top is at the cap-height.
  • 6. The icon is treated as a single character and can be deleted using backspace with a single keystroke when the cursor is positioned accordingly
  • 7. If the font size changes, the icon size is adjusted automatically

Alternative Success Scenario A:

  • Step 1. and 2. above applies
  • A-1: The user starts typing a non-supported combination like ":nonsense:"
  • A-2: The content is unaltered and displayed as is

Notes:

  • There are various ways of how an inline image can be handled. Let's start with the most common one, where the image is fully in-line with the line-height and does not break the flow of the paragraph
  • I would argue that other inline versions are not required at this point. For the sake of solving the technical aspects on how inline images might affect the rendering of lines of text, we can create a separate ticket, but from my point of view there is no requirement to have that.
  • Please see the Figma File for an example where it would break the line-height.
  • All drop-down selection and auto-complete functionality for inline icons and emojis (like in GitHub or Slack) will be addressed later.

Image Preview:

fire-1

fire-2

@bk-one bk-one self-assigned this Jan 5, 2021
@bk-one bk-one added this to the V0.0.1 milestone Jan 6, 2021
@bk-one bk-one changed the title Inline Image Support Inline non-unicode image support (icons and emojis) Jan 6, 2021
@bk-one bk-one removed their assignment Jan 6, 2021
@slightfoot slightfoot self-assigned this Jan 7, 2021
@matthew-carroll matthew-carroll added area_infrastructure Pertains to cross-cutting infrastructure status_needs_analysis A maintainer needs to break down this ticket into action items. type_product_feature Describes a product capability rather than an actionable Super Editor capability. labels Jun 5, 2021
@matthew-carroll matthew-carroll added the customer_superlist Needed by Superlist label Jun 5, 2021
@matthew-carroll
Copy link
Contributor

Closing this ticket in favor of this meta ticket: #2439

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area_infrastructure Pertains to cross-cutting infrastructure customer_superlist Needed by Superlist status_needs_analysis A maintainer needs to break down this ticket into action items. type_product_feature Describes a product capability rather than an actionable Super Editor capability.
Projects
None yet
Development

No branches or pull requests

3 participants