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: Counter #495

Closed
10 tasks done
Tracked by #441
thrbnhrtmnn opened this issue Oct 24, 2023 · 3 comments
Closed
10 tasks done
Tracked by #441

Storybook Documentation - Component: Counter #495

thrbnhrtmnn opened this issue Oct 24, 2023 · 3 comments
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

@thrbnhrtmnn
Copy link
Contributor

thrbnhrtmnn commented Oct 24, 2023

Description / User Story

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


Acceptance Criteria

  • 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
      • Variant (incl. variant = default, warning, error)
      • 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 "Counter" 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 "Counter" and "[componentName]" with "counter".

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
@JpunktWpunkt
Copy link
Contributor

@thrbnhrtmnn
Copy link
Contributor Author

thrbnhrtmnn commented Jan 3, 2024

Feedback:

  • Props: We should change the variant selection to a radio and also change the description from "Select..." to "Choose..."
  • Variant: Please change "warning" to "warn", this is the correct name of the value.

@JpunktWpunkt , looks really good, exactly as defined. But once looking at it again I would change two things, as commented above and already changed in the Excel.

@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
@thrbnhrtmnn
Copy link
Contributor Author

Looks good, just approved the PR

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

No branches or pull requests

2 participants