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: enhance storybook samples #7454

Merged
merged 3 commits into from
Sep 14, 2023
Merged

docs: enhance storybook samples #7454

merged 3 commits into from
Sep 14, 2023

Conversation

hinzzx
Copy link
Contributor

@hinzzx hinzzx commented Aug 16, 2023

As a part of the #7284 initiative we enhanced the Storybook samples for the following components:

Bar

  • Cleared the JSDoc enums;
  • Changed the story name to -> Basic

Button

  • Cleared JSDoc enums;
  • Remove redunant Storybook samples;

DatePicker

  • Cleared JSDoc enums;

DynamicSideContent

  • Added custom styling to the native HTML tags as changing the themes wasn't updating the content. For example on Dark themes like Evening Horizon, both the background and the text would appear dark, which led to poor user experience;

FileUploader

  • Cleared JSDoc enums
  • Moved the Custom FileUploader sample to lower position, because we do not encourage using non-focusable elements;

Menu

  • Fixed wrong property name headerText -> header-text because it wasnt showing on Mobile Devices;
  • Changed sample name -> Basic with Header Text -> Basic

SplitButton

  • Cleared JSDoc enums;
  • Remove redunant Storybook samples;

StepInput

  • Cleared JSDoc enums;
  • Wrapped the main story component in the Storybook in a div with max-width: 13rem, due to component being stretched to the whole page, causing poor user experience;
  • Simplified and removed redunant Storybook samples;

Switch

  • Remove redunant Storybook samples;
  • Reduced the Textual Switch samples because we do not encourage using Text in our switch component;

ToggleButton

  • Enhance samples;

@hinzzx hinzzx requested review from a team, ilhan007 and nnaydenow August 16, 2023 09:14
@didip1000 didip1000 self-requested a review August 17, 2023 07:13
@hinzzx hinzzx requested a review from BorisDafov August 23, 2023 12:08
@NHristov-sap NHristov-sap self-requested a review August 24, 2023 11:00
Copy link
Contributor

@unazko unazko left a comment

Choose a reason for hiding this comment

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

Components which still have longer wrapping on two lines sample names:

  • DatePicker
  • DateTimePicker
  • DateRangePicker
  • Calendar
  • TimePicker
  • ColorPalettePopover

@hinzzx hinzzx merged commit acf5c66 into main Sep 14, 2023
7 checks passed
@hinzzx hinzzx deleted the topicB-docs-feedback branch September 14, 2023 19:53
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.

3 participants