Skip to content
This repository has been archived by the owner on Jan 6, 2025. It is now read-only.

Add basic component usage guidelines #322

Merged
merged 49 commits into from
Feb 7, 2022
Merged

Add basic component usage guidelines #322

merged 49 commits into from
Feb 7, 2022

Conversation

daviddossett
Copy link
Collaborator

@daviddossett daviddossett commented Jan 28, 2022

Link to relevant issue

This pull request partly resolves #126

Description of changes

This PR provides an initial set of lightweight usage guidelines for each component in the form of simple do/don't examples. It also adds an image to each component's README to give a quick preview of what each component looks like.

To do:

  • Add example artwork to each do/don't example after updating text based on feedback
  • Fix image resolution
  • Wordsmithing/polish/proofreading
  • Organize image assets into folders to avoid bloat in /assets

Example

CleanShot 2022-01-27 at 16 11 51@2x

@daviddossett daviddossett added this to the January 2022 milestone Jan 28, 2022
@daviddossett daviddossett added the documentation Improvements or additions to documentation label Jan 28, 2022
Copy link
Member

@hawkticehurst hawkticehurst left a comment

Choose a reason for hiding this comment

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

Looks fantastic thus far! Can't wait to see the updated illustrations.

@daviddossett daviddossett marked this pull request as ready for review February 4, 2022 00:37
@daviddossett
Copy link
Collaborator Author

cc @albertelo

Copy link

@miguelsolorio miguelsolorio left a comment

Choose a reason for hiding this comment

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

Some minor feedback on the examples but nothing that is a shipping blocker. These guidelines are a HUGE upgrade that make the extension guidelines look weak 😄 great work all around as this is crucial work for people using the toolkit.

Copy link
Member

@hawkticehurst hawkticehurst left a comment

Choose a reason for hiding this comment

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

This looks incredible! After you address all my comments I'm happy to merge whenever.

@daviddossett daviddossett merged commit 752e33b into microsoft:main Feb 7, 2022
daviddossett added a commit that referenced this pull request Feb 18, 2022
* Update button `disabled` attribute logic (#323)

Description of changes

Update logic for setting the `disabled` attribute value in the button component to fix a cross-browser bug.

* Add basic component usage guidelines (#322)

* Add badge and button guidelines without images

* Add checkbox guidelines

* Add divider guidelines

* Add badge artwork

* Update badge sections

* Fix image

* Update badge image

* Add hero assets for all components

* More guideline updates

* More do/don'ts

* Add radio and tag guidance

* Add text field guidelines

* Polish docs

* Remove unused image

* Remove unused image

* Update assets structure

* Fix progress ring corner radius

* Fix images paths

* Update button guidelines

* Add link to button guidelines

* Grammar fixes

* Clarify text field guidelines

* Grammar

* PR feedback

* Fix button images resolution

* Update badge artwork. Add button artwork

* Finish button artwork

* Add checkbox artwork

* Fix button size in table

* More image res fixes

* Add data grid and divider artwork

* Add dropdown artwork

* Add link artwork

* Add panels guidelines

* Add progress ring artwork

* Add radio group artwork

* Add missing alt text to radio image markdown

* Add tag artwork

* Add text area artwork

* Add text field artwork

* Fix missing badge artwork and alt text

* Fix badge border radius

* Add icon button example

* PR feedback: update checkbox, data grid and dropdown

* More PR feedback

* Update basic example titles

* Fix panel size

* Initial commit

* Try forcing scrollbar background with !important

* FIx high contrast theme
@albertelo
Copy link

Thanks for this work! Is this live already?

@hawkticehurst
Copy link
Member

@albertelo yep! Look at any of our component docs and you should see these guidelines 😊

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create guides and best practices for extension authors
4 participants