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

docs(button): update button description #447

Merged
merged 11 commits into from
Mar 22, 2023

Conversation

linstedt
Copy link
Collaborator

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build (yarn build) was run locally and any changes were pushed
  • Unit tests (yarn test) were run locally and passed
  • Visual Regression Tests (yarn visual-regression) were run locally and passed
  • Linting (npm lint) was run locally and passed

Pull request type

Please check the type of change your PR introduces:

  • Bug fix
  • Feature
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

GitHub Issue Number: N/A

What is the new behavior?

Does this introduce a breaking change?

  • Yes
  • No

Testing

Other information

Open Questions:

  • Icon button with icon size 32px available in components but not in Styleguide - do we need this variant?
  • Icon button shapes: Currently, some components don't follow the rules described here (e.g. clear button in search field) - should it be fixed?
  • Button group: What button variants are available? Is there always at least one primary button? Or is that the selected one?

@linstedt linstedt added the Documentation Improvements or additions to documentation label Mar 15, 2023
@linstedt linstedt self-assigned this Mar 15, 2023
@linstedt
Copy link
Collaborator Author

@danielleroux @nuke-ellington We would like to add a code example on the top to give an interactive example for each description. Silvio had some feedback coming in about the lack of theming of the illustrations, this could be a small work around. What do you think?

@danielleroux danielleroux added this to the 1.5.0 milestone Mar 17, 2023
Copy link
Collaborator

@nuke-ellington nuke-ellington left a comment

Choose a reason for hiding this comment

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

Made some suggestions to the text

packages/documentation/docs/controls/_button_styleguide.md Outdated Show resolved Hide resolved
packages/documentation/docs/controls/_button_styleguide.md Outdated Show resolved Hide resolved
packages/documentation/docs/controls/_button_styleguide.md Outdated Show resolved Hide resolved
packages/documentation/docs/controls/_button_styleguide.md Outdated Show resolved Hide resolved
packages/documentation/docs/controls/_button_styleguide.md Outdated Show resolved Hide resolved
packages/documentation/docs/controls/_button_styleguide.md Outdated Show resolved Hide resolved
packages/documentation/docs/controls/_button_styleguide.md Outdated Show resolved Hide resolved
packages/documentation/docs/controls/_button_styleguide.md Outdated Show resolved Hide resolved
packages/documentation/docs/controls/_button_styleguide.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@nuke-ellington nuke-ellington left a comment

Choose a reason for hiding this comment

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

lgtm

@danielleroux danielleroux merged commit 4b45938 into main Mar 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants