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: Tooltip Bubble #715

Closed
13 tasks done
Tracked by #441
angelicahoyss opened this issue Dec 20, 2023 · 2 comments · Fixed by #821
Closed
13 tasks done
Tracked by #441

Storybook Documentation - Component: Tooltip Bubble #715

angelicahoyss opened this issue Dec 20, 2023 · 2 comments · Fixed by #821
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 Dec 20, 2023

Description / User Story

With this task we want to make the Tooltip Bubble 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
      • Elevation (with and without elevation: elevation = true & elevation = false)
      • Has Arrow (with and without arrow: hasArrow = true & hasArrow = false)
    • Content / Settings
      • Message
  • 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
  • Tooltip Bubble should be displayed under Internal Components ❓ Feedback > Tooltip (together with the Tooltip component)

Props

See this table page "TooltipBubble" 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 "Tooltip Bubble" and "[componentName]" with "tooltipBubble".

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
@angelicahoyss angelicahoyss changed the title [Component name] - [task description] Storybook Documentation - Component: Tooltip Bubble Dec 20, 2023
@angelicahoyss angelicahoyss added 📋 task::ready Task is ready to be picked up or planned in ⌨️ dev issue Task is for developers labels Dec 20, 2023
@RubirajAccenture RubirajAccenture self-assigned this Dec 22, 2023
@thrbnhrtmnn thrbnhrtmnn added ⭕ core team issue This is for the core team and should not be done by contributors and removed 📋 task::ready Task is ready to be picked up or planned in labels Jan 5, 2024
@bar-tay bar-tay assigned bar-tay and unassigned RubirajAccenture Jan 23, 2024
@bar-tay bar-tay linked a pull request Jan 23, 2024 that will close this issue
@thrbnhrtmnn
Copy link
Contributor

Hey @bar-tay , the documentation itself looks perfect, no comments there. But I did not see the open question mark in the description above regarding the placement of the component in the current folder structure. Please move the component back to the "Feedback" folder and place it together with the "Tooltip" component in a new "Tooltip" folder (similar to the Radio Group).

@thrbnhrtmnn
Copy link
Contributor

After merge the issue can be closed

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