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

Storybook Documentation - Component: Icon #423

Closed
10 tasks
Tracked by #441
angelicahoyss opened this issue Oct 6, 2023 · 1 comment · Fixed by #756
Closed
10 tasks
Tracked by #441

Storybook Documentation - Component: Icon #423

angelicahoyss opened this issue Oct 6, 2023 · 1 comment · Fixed by #756
Assignees
Labels
⭕ core team issue This is for the core team and should not be done by contributors ⌨️ dev issue Task is for developers

Comments

@angelicahoyss
Copy link
Contributor

angelicahoyss commented Oct 6, 2023

Description / User Story

With this task we want to make the Icon Component page in Storybook look like the template from design.


Acceptance Criteria

  • The current Overview of all icons has been moved from the Icon Component Page to a new Page under "Foundation" with the name "Icons"
  • Component Page has the same structure as the design template (in the following order):
    • Headline & Intro Text incl. a list of anchor links to all following sections
    • Docs Area with Example and all Props (see which props should be displayed for this component in the section below)
    • Appearance
      • SizeVariant (incl. sizeVariant = SM, MD, LG)
  • Component Page includes the texts as defined in the section below (incl. non default values for the shown examples)
  • Component Page text styles (uppercase, lowercase, spacing) correspond the the design template
  • Component Page spacing corresponds to design template
  • Component Page colours correspond to design template

Props

See this table page "Icon" for all props that should be displayed for the component, incl. their description, default values and the type of controls. Props that do not appear and that can be removed, should also be removed (not including theme for example, because this is needed for all components, but still not part of the props section)

If the props in the list are not the same as the component currently uses, just leave a comment in column G in the excel and a follow-up task will be created. Fixing the components is not part of this ticket.


Content / Texts

See this table page "Documentation Texts" for all texts that should be displayed for the component. Filter column A in cell A3 to only show you the texts of this components.

For the texts please change "[component name]" with "Icon" and "[componentName]" with "icon".

Also all the examples in the documentation below the Props should not use the default values, but they should use descriptive texts for Label, Placeholder and other text fields. Some examples are already given in the template.


Background information

  • Example of a collapsible Props Section can be seen here
@thrbnhrtmnn thrbnhrtmnn added this to the Release 1.0 milestone Oct 11, 2023
@JpunktWpunkt JpunktWpunkt self-assigned this Dec 7, 2023
@thrbnhrtmnn thrbnhrtmnn added ⭕ core team issue This is for the core team and should not be done by contributors and removed 📋 task::planned labels Jan 5, 2024
@JpunktWpunkt JpunktWpunkt removed their assignment Jan 8, 2024
@bar-tay bar-tay assigned bar-tay and unassigned thrbnhrtmnn Jan 9, 2024
@bar-tay bar-tay linked a pull request Jan 10, 2024 that will close this issue
@bar-tay bar-tay removed a link to a pull request Jan 10, 2024
@bar-tay bar-tay linked a pull request Jan 10, 2024 that will close this issue
@thrbnhrtmnn
Copy link
Contributor

thrbnhrtmnn commented Jan 16, 2024

Hey @bar-tay , here is my feedback:

  • The first AC is still open: The current Overview of all icons has been moved from the Icon Component Page to a new Page under "Foundation" with the name "Icons", after this is done, the idea was to only show one icon in the default story, which can also be switched via the icon prop. If this is not how the icon component works, than we should discuss alternatives.
  • Props: is ignoreSize a prop in the component? This was not there when we started the briefing for the documentation. Do you know what it does and could you make a suggestion for the description?
  • Props: Aria label does not have a way to input a text for it. Is the prop also implemented in the component, if not please remove the prop from the documentation.
  • SizeVariant: Please update the text to the one from the excel. The text should be about the Icon and not the Checkbox and it has 6 sizes.
  • SizeVariant: The example should only show the default icon (blr360) in all 6 sizes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⭕ core team issue This is for the core team and should not be done by contributors ⌨️ dev issue Task is for developers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants