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

Components documentation list #2156

Closed
38 tasks done
laliq opened this issue Apr 12, 2022 · 10 comments
Closed
38 tasks done

Components documentation list #2156

laliq opened this issue Apr 12, 2022 · 10 comments
Assignees

Comments

@laliq
Copy link
Contributor

laliq commented Apr 12, 2022

For Storybook

@martalalik
Copy link
Contributor

martalalik commented Jun 15, 2022

For Zeroheight

  • Avatar - it does't exists in Components section, but there is documentation in Foundation section. Maybe there is a reason for it 🤔 ?
  • Autocomplete - there is no documentation.
  • Banner - got additional description &Text example is wrong is a repetition of Text and Icon example.
  • Breadcrumbs - lack of links to rest of the examples.
  • Button - i would link Icon button & Progress button & Full width examples.
  • Card - got additional description & i would link With media & With divider examples.
  • Chip - lack of links to rest of the examples.
  • Dialog - lack of links to rest of the examples & the Demo view it doesn’t show well the example after triggering the Dialog.
  • Divider - got additional description & lack of links to rest of the examples.
  • Menu - link is broken & i would link Complex example.
  • Paper - it does't exists in Components section, but there is documentation in Foundation as Elevation. Not sure if we need listed as a component 🤔 .
  • Popover - i would link With Tooltip example.
  • Progress:Dot - link is broken.
  • Scrim - link is broken & got additional description.
  • Search - link is broken & lack of links to rest of the examples.
  • Select:Native - link is broken.
  • Side Sheet - - link is broken & lack of links to rest of the examples & got additional description.
  • Slider - lack of links to rest of the examples.
  • Snackbar - got additional description.
  • Table - got additional description.
  • TableOfContent - link is broken.
  • Tabs - the link might broke after the merge, maybe link more examples? And the most confusing is this: Tabs have a minimum width of Spacer/16 - Medium on each side of the label. we took it away from the storybook.
  • TextField - lack of links to rest of the examples. The examples from Figma in Zeroheight are misleading because the helper text is overlapping with icon and another text.

@BeckyBrekke
Copy link
Contributor

BeckyBrekke commented Jun 22, 2022

fixed broken links
@Hjaf - can you check the fixes I did here? I only fixed the broken links on the overview and code pages, the rest of the comments I added to: https://app.zenhub.com/workspace/o/equinor/design-system/issues/2332

  • Menu - fixed links - overview and code
  • Progress:Dot - fixed links, code and dot on overview
  • Scrim - fixed links - overview and code
  • Search - fixed links - overview and code
  • Select:Native - fixed all links on overview (removed default from all) and code
  • Side Sheet - fixed links on overview and code
  • TableOfContent - fixed link on overview and code
  • Tabs - fixed links on overview and code
  • selection controls - checkboxes, radio, switch - fixed links on overview and code

@Hjaf
Copy link
Collaborator

Hjaf commented Jun 22, 2022

image
Seems like something is wrong with this one. (single select compact)

@lucasveil
Copy link
Contributor

lucasveil commented Aug 11, 2022

Reviewed from design team written in bold

  • Avatar - it does't exists in Components section, but there is documentation in Foundation section. Maybe there is a reason for it 🤔 ?
    Avatar is a token and doesn't exist as a component
  • Autocomplete - there is no documentation.
    Autocomplete is not set in design component
  • Banner - got additional description &Text example is wrong is a repetition of Text and Icon example.
    Text alone is now deleted and added the compact version
  • Breadcrumbs - lack of links to rest of the examples.
    Added text "More examples available in the code tab"
  • Button - i would link Icon button & Progress button & Full width examples.
    Icon button is showed in the variant section. Full width button have been added to the demo
  • Card - got additional description & i would link With media & With divider examples.
    Card with divider have been added
  • Chip - lack of links to rest of the examples.
    Added text "More examples available in the code tab"
  • Dialog - lack of links to rest of the examples & the Demo view it doesn’t show well the example after triggering the Dialog.
    Added text "More examples available in the code tab"
  • Divider - got additional description & lack of links to rest of the examples.
    Added text "More examples available in the code tab"
  • Menu - link is broken & i would link Complex example.
    Link is fixed and added compact to the demo
  • Paper - it does't exists in Components section, but there is documentation in Foundation as Elevation. Not sure if we need listed as a component 🤔 .
    If understood weel paper is a tokenm only for code, this one doesn't exist in figma. The one we use is "sidesheet, card" in tokens"
  • Popover - i would link With Tooltip example.
    Added text "More examples available in the code tab"
  • Scrim - link is broken & got additional description.
    Link and description are fixed
  • Search - link is broken & lack of links to rest of the examples.
    Rebecca added text "More examples available in the code tab"
  • Side Sheet - - link is broken & lack of links to rest of the examples & got additional description.
    Rebecca added text "More examples available in the code tab"
  • Slider - lack of links to rest of the examples.
    Added text "More examples available in the code tab"
  • Snackbar - got additional description.
    **Added description and compact **
  • Table - got additional description.
    **Updated description **
  • Tabs - the link might broke after the merge, maybe link more examples? And the most confusing is this: Tabs have a minimum width of Spacer/16 - Medium on each side of the label. we took it away from the storybook.
    ** Link is fixed and changed the demo to states, deleted the width space since it is not relevant **
    Rebecca added text "More examples available in the code tab"
  • TextField - lack of links to rest of the examples. The examples from Figma in Zeroheight are misleading because the helper text is overlapping with icon and another text.
    Added text "More examples available in the code tab" and for the overlapping of icon and text it is because it is made as a varaint. May be fixed in EDS 2.0
  • Toggle Button
    **Added text, not available in code **

Ready for review @BeckyBrekke @martalalik

@martalalik
Copy link
Contributor

martalalik commented Aug 15, 2022

Seems like something is wrong with this one. (single select compact)

This one is deprecated @Hjaf

@martalalik
Copy link
Contributor

Image placeholder in code the link is broken.

@mimarz
Copy link
Contributor

mimarz commented Aug 16, 2022

Image placeholder in code the link is broken.

We don't have a placeholder for images in code as its some specific for Figma, so maybe remove the code tab from this? @lucasveil

@lucasveil
Copy link
Contributor

lucasveil commented Aug 18, 2022

Agreed @mimarz The code tab is now hidden

@BeckyBrekke
Copy link
Contributor

BeckyBrekke commented Aug 23, 2022

Looks good @lucasveil . I just added the sentence about "more examples available in code" to search, side sheet and tabs. Do you want to check anything else @martalalik or can we publish the changes?

@martalalik
Copy link
Contributor

Closing this one, we can continue with #2332

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants