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

updates Dropdown documentation, adds documentation assets folders #554

Merged
merged 3 commits into from
Mar 4, 2022

Conversation

jasonbasuil
Copy link
Collaborator

@jasonbasuil jasonbasuil commented Feb 22, 2022

closes #226

@@ -1,26 +1,27 @@
import { ArgsTable, Story, Canvas } from '@storybook/addon-docs/blocks';
import DropdownLabelAsset from '../../.storybook/documentation/assets/Dropdown/Dropdown__label.png';
import DropdownIconAsset from '../../.storybook/documentation/assets/Dropdown/Dropdown__icon.png';
Copy link
Collaborator

@rroppolo rroppolo Mar 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My only fear is that these static images may get out of date really quickly...

I wonder if we could experiment with the storybook Figma plugin and embed the figma file directly?

https://pocka.github.io/storybook-addon-designs/?path=/docs/internal-blocks-design--foo

There seems to be a way to embed a Figma file in the Docs mdx file like:

import { Figma } from "storybook-addon-designs/blocks"

<Figma url="https://foo.bar/baz" />

Full disclosure I have not tried that at all so it may not work 😅 But I am hesitant to introduce static images to the design system because I feel like it will be an extra barrier to making changes quickly.... So might be worth a quick try if this will serve a similar purpose before we fully commit to images.

Edit: Just tried it and it does kind of work:
Screen Shot 2022-03-01 at 7 44 42 PM

I'm not too familiar with Figma so not sure if there is a way to create a new document with just the section you want here (not the whole Dropdowns page). Ideally with that new Figma doc being built using the same Figma components so that any changes to the dropdown will propagate. But that's the general idea - hope that makes sense

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! Thank you bringing this up! This was also a concern I had as well but didn't know something like this existed. This definitely seems like something we could use instead.

This probably will be an open question for @katiebratt and @natkasman , but if we were to have these two screenshot examples living in a Figma doc somewhere (I'm assuming it would have to be their own Figma page in order to link to it ... since it looks like this ` doesn't focus on specific nodes but the entire page. Is this something we could look into? Would probably save us from screenshots going out of date and makes collaborating on documentation easier.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is so cool! I made a separate page on Figma so it only shows those components. Let me know if this works!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks real spiffy! This is pretty exciting since it increases visibility for best practices and also if you wanted to include any extra guidance you can also do it directly in Figma to illustrate guidelines and it should always be up to date! Thank you!

Screen Shot 2022-03-04 at 12 27 28 PM

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OMG that's so cool! Thank you both for looking into that and making it a reality!!

Copy link
Collaborator

@rroppolo rroppolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

@jasonbasuil jasonbasuil merged commit 5a360c1 into develop Mar 4, 2022
@jasonbasuil jasonbasuil deleted the chore/UIDS-226-dropdown-documentation-update branch March 4, 2022 20:59
jasonbasuil added a commit that referenced this pull request Mar 9, 2022
* updates Dropdown documentation, adds Figma addon for illustrations (#554)

* add transparent Button variant & update DropdownIconToggle (#560)

Adding the transparent and outline transparent variant to the Button component. Uses transparent button variant in ModalFooter actions for closing. Updates DropdownToggle to support icon-only dropdown. Removes DropdownIconToggle in favor of using DropdownToggle to better support flexible styling.

* Prepare release 1.28.0

Co-authored-by: Jason Basuil <basuilj@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
jasonbasuil added a commit that referenced this pull request Jul 14, 2022
* allows Tooltip to open on hover (#487)

* Prepare hotfix 1.24.1 (#492)

* Merge release/1.25.0 into main branch (#494)

* HOTFIX update tooltip primary variant to ux-emerald (#415)

* Feature RS-8352 Tabs (#477)

Add Tabs and Tabs with react-bootstrap and styled-components

* feature/UIDS-442 add Button to DS (#450)

Adds react-bootstrap and Button component to the Design System

* Bug/UIDS-484 Set node version on nightly visual tests (#485)

* chore/UIDS-476 documentation updates (#486)

* Chore/ Add Percy snapshots for buttons (#488)

* Chore/ Delete old sample file for cypress tests (#482)

* Merge hotfix/1.24.1 into develop branch (#493)

* allows Tooltip to open on hover (#487)

* Prepare release 1.25.0

Co-authored-by: Rachel Roppolo <rachel@userinterviews.com>
Co-authored-by: Jane Sebastian <jane@userinterviews.com>
Co-authored-by: Jason Basuil <basuilj@gmail.com>
Co-authored-by: brianCollinsUI <84730553+brianCollinsUI@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* update relative bootstrap imports (#497)

* Prepare hotfix 1.25.1 (#498)

* Merge release/1.26.0 into main branch (#513)

* HOTFIX update tooltip primary variant to ux-emerald (#415)

* Feature RS-8352 Tabs (#477)

Add Tabs and Tabs with react-bootstrap and styled-components

* feature/UIDS-442 add Button to DS (#450)

Adds react-bootstrap and Button component to the Design System

* Bug/UIDS-484 Set node version on nightly visual tests (#485)

* chore/UIDS-476 documentation updates (#486)

* Chore/ Add Percy snapshots for buttons (#488)

* Chore/ Delete old sample file for cypress tests (#482)

* Merge hotfix/1.24.1 into develop branch (#493)

* allows Tooltip to open on hover (#487)

* Merge release/1.25.0 into develop branch (#495)

* allows Tooltip to open on hover (#487)

* Prepare hotfix 1.24.1 (#492)

* Prepare release 1.25.0

Co-authored-by: Jason Basuil <basuilj@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Merge hotfix/1.25.1 into develop branch (#499)

* allows Tooltip to open on hover (#487)

* Prepare hotfix 1.24.1 (#492)

* Merge release/1.25.0 into main branch (#494)

* HOTFIX update tooltip primary variant to ux-emerald (#415)

* Feature RS-8352 Tabs (#477)

Add Tabs and Tabs with react-bootstrap and styled-components

* feature/UIDS-442 add Button to DS (#450)

Adds react-bootstrap and Button component to the Design System

* Bug/UIDS-484 Set node version on nightly visual tests (#485)

* chore/UIDS-476 documentation updates (#486)

* Chore/ Add Percy snapshots for buttons (#488)

* Chore/ Delete old sample file for cypress tests (#482)

* Merge hotfix/1.24.1 into develop branch (#493)

* allows Tooltip to open on hover (#487)

* Prepare release 1.25.0

Co-authored-by: Rachel Roppolo <rachel@userinterviews.com>
Co-authored-by: Jane Sebastian <jane@userinterviews.com>
Co-authored-by: Jason Basuil <basuilj@gmail.com>
Co-authored-by: brianCollinsUI <84730553+brianCollinsUI@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* update relative bootstrap imports (#497)

* Prepare hotfix 1.25.1

Co-authored-by: Jason Basuil <basuilj@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Rachel Roppolo <rachel@userinterviews.com>
Co-authored-by: Jane Sebastian <jane@userinterviews.com>
Co-authored-by: brianCollinsUI <84730553+brianCollinsUI@users.noreply.github.com>

* Chore/wait a bit longer for things to render on some percy snapshots (#503)

* UIDS-438 Add AsyncCreatableSelect (#500)

* UIDS-506 Update Form to handle GET method (#507)

Previously passing a GET method would have worked for Rails, but it wouldn't
put the params in the URL which is the expected behavior. This makes it so we
properly pass GET directly to the form method parameter.

One other thing this does is remove the CSRF params if GET is passed. These are
ignored in GET and thus aren't necessary and would add extra params to the URL.

One potential upgrade that was left on the cutting room floor was passing any
extra props directly to the form component.

* CHORE Fix node version in deploy action (#510)

* CHORE Fix yaml spacing on deploy action (#512)

* feature/UIDS-312 add Dropdown to DS (#502)

* adds Dropdown and subcomponents

* adds DropdownIconToggle

* creates shared button mixins

* remove children proptype, consolidate shared proptypes

* add Percy snapshots for Dropdowns

* Prepare release 1.26.0

Co-authored-by: Rachel Roppolo <rachel@userinterviews.com>
Co-authored-by: Jane Sebastian <jane@userinterviews.com>
Co-authored-by: Jason Basuil <basuilj@gmail.com>
Co-authored-by: brianCollinsUI <84730553+brianCollinsUI@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Bob Saris <bob@userinterviews.com>

* Merge release/1.26.1 into main branch (#517)

* UIDS-501 Export color variables for use in js (#504)

* use font-type-30 on form-control (#516)

* Prepare release 1.26.1

* Fix merge conflicts on 1.27.0

* Merge release/1.28.0 into main branch (#563)

* updates Dropdown documentation, adds Figma addon for illustrations (#554)

* add transparent Button variant & update DropdownIconToggle (#560)

Adding the transparent and outline transparent variant to the Button component. Uses transparent button variant in ModalFooter actions for closing. Updates DropdownToggle to support icon-only dropdown. Removes DropdownIconToggle in favor of using DropdownToggle to better support flexible styling.

* Prepare release 1.28.0

Co-authored-by: Jason Basuil <basuilj@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Merge release/1.29.0 into main branch (#569)

* add CardList to DS (#567)

Adds a CardList layout component to wrap around existing design system Cards.

* update Pill color and border (#568)

Updates Pills colors, removes Pill border, and introduces a Pills layout component to wrap around a collection of Pill components.

* Prepare release 1.29.0

Co-authored-by: Jason Basuil <basuilj@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Merge release/1.29.1 into main branch (#578)

* remove margin from Card (#572)

* rename CardList to CardContainer (#574)

Co-authored-by: Jason Basuil <basuilj@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Merge release/1.29.2 into main branch (#594)

* Button and Link distinction documentation (#587)

* add brand variants to Button (#593)

Co-authored-by: Jason Basuil <basuilj@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* remove extra version in package.json

* Merge release/1.30.0 into main branch (#611)

* removing TrackedButton from export (#603)

* add aria-live to Toast (#605)

* handle setting title prop on Toast (#607)

* update focus state to Button and Select (#601)

Co-authored-by: Jason Basuil <basuilj@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Merge release/1.30.1 into main branch (#618)

* fix styles on Select to allow for tabbing and proper focus (#617)

* Merge release/1.30.2 into main branch (#624)

* allow setting id on InputLabel (#621)

* add id to FormGroup__invalid-feedback (#623)

* Merge release/1.30.3 into main branch (#629)

* update Input focus boder to ux-blue-500 for 3:1 contrast ratio (#628)

* Merge release/1.31.0 into main branch (#633)

* update FormGroup and InputLabel to support fieldset and legend (#632)

* Merge release/1.31.1 into main branch (#642)

* change FormControlLabel label and children to span (#638)

* updating input scss variables (#641)

* Prepare release 1.31.1

* Merge release/1.32.0 into main branch (#660)

* remove required id from FormGroup (#645)

* Fix cypress tests (#647)

* Add data-testid to LoadingOverlay (#652)

* add Link variant to Button component (#659)

* upgrade react-select v5 (#658)

* Add Accordion to DS (#656)

* update snapshots

* Prepare release 1.32.1

Co-authored-by: Jason Basuil <basuilj@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Rachel Roppolo <rachel@userinterviews.com>
Co-authored-by: Jane Sebastian <jane@userinterviews.com>
Co-authored-by: brianCollinsUI <84730553+brianCollinsUI@users.noreply.github.com>
Co-authored-by: Bob Saris <bob@userinterviews.com>
Co-authored-by: Rachel Roppolo <rroppolo@Rachels-MacBook-Pro.local>
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

Successfully merging this pull request may close these issues.

Dropdowns documentation
3 participants