From acf5c6683b828e6dec0094eba6a73c14d7566ada Mon Sep 17 00:00:00 2001
From: Stoyan <88034608+hinzzx@users.noreply.github.com>
Date: Thu, 14 Sep 2023 22:53:37 +0300
Subject: [PATCH] docs: enhance storybook samples (#7454)
*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;
---
packages/fiori/src/Bar.ts | 16 +---
packages/main/src/Button.ts | 21 ------
packages/main/src/DatePicker.ts | 9 ---
packages/main/src/FileUploader.ts | 10 ---
packages/main/src/SplitButton.ts | 12 ---
packages/main/src/StepInput.ts | 9 ---
.../_stories/fiori/Bar/Bar.stories.ts | 2 +-
.../DynamicSideContent.stories.ts | 38 +++++-----
.../_stories/main/Button/Button.stories.ts | 52 +++++--------
.../main/Calendar/Calendar.stories.ts | 2 +-
.../main/DatePicker/DatePicker.stories.ts | 2 +-
.../DateRangePicker.stories.ts | 4 +-
.../DateTimePicker/DateTimePicker.stories.ts | 2 +-
.../main/FileUploader/FileUploader.stories.ts | 9 +--
.../_stories/main/Menu/Menu.stories.ts | 4 +-
.../main/SplitButton/SplitButton.stories.ts | 45 ++++-------
.../main/StepInput/StepInput.stories.ts | 74 ++++++++-----------
.../_stories/main/Switch/Switch.stories.ts | 30 +-------
.../main/ToggleButton/ToggleButton.stories.ts | 42 ++++-------
19 files changed, 115 insertions(+), 268 deletions(-)
diff --git a/packages/fiori/src/Bar.ts b/packages/fiori/src/Bar.ts
index 2bad152b0816..70b4d323b01e 100644
--- a/packages/fiori/src/Bar.ts
+++ b/packages/fiori/src/Bar.ts
@@ -71,16 +71,6 @@ class Bar extends UI5Element {
/**
* Defines the component's design.
*
- *
- * Note:
- * Available options are:
- *
Header
Subheader
Footer
FloatingFooter
Default
Emphasized
Positive
Negative
Transparent
Attention
Button
Submit
Reset
type
property to have effect, you must add the following import to your project:
* import "@ui5/webcomponents/dist/features/InputElementsFormSupport.js";
*
diff --git a/packages/main/src/DatePicker.ts b/packages/main/src/DatePicker.ts
index ecbc692885e6..49ef0fbd65fc 100644
--- a/packages/main/src/DatePicker.ts
+++ b/packages/main/src/DatePicker.ts
@@ -226,15 +226,6 @@ class DatePicker extends DateComponentBase implements IFormElement {
/**
* Defines the value state of the component.
- * None
Error
Warning
Success
Information
None
Error
Warning
Success
Information
Default
Emphasized
Positive
Negative
Transparent
Attention
None
Error
Warning
Success
Information
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc ex mi, elementum et ante commodo, semper sollicitudin magna. Sed dapibus ut tortor quis varius. Sed luctus sem at nunc porta vulputate. Suspendisse lobortis arcu est, quis ultrices ipsum fermentum a. Vestibulum a ipsum placerat ligula gravida fringilla at id ex. Etiam pellentesque lorem sed sagittis aliquam. Quisque semper orci risus, vel efficitur dui euismod aliquet. Morbi sapien sapien, rhoncus et rutrum nec, rhoncus id nisl. Cras non tincidunt enim, id eleifend neque.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc ex mi, elementum et ante commodo, semper sollicitudin magna. Sed dapibus ut tortor quis varius. Sed luctus sem at nunc porta vulputate. Suspendisse lobortis arcu est, quis ultrices ipsum fermentum a. Vestibulum a ipsum placerat ligula gravida fringilla at id ex. Etiam pellentesque lorem sed sagittis aliquam. Quisque semper orci risus, vel efficitur dui euismod aliquet. Morbi sapien sapien, rhoncus et rutrum nec, rhoncus id nisl. Cras non tincidunt enim, id eleifend neque.
Morbi lorem libero, imperdiet id condimentum ac, tempor ut velit. Integer a laoreet sem. Nunc at sagittis nisi. Sed placerat diam eu porttitor dignissim. Maecenas nec fringilla tortor. Pellentesque ut elit est. Curabitur quis elit at mauris ullamcorper fringilla. Nullam diam mi, porttitor dictum orci nec, molestie luctus metus. Nunc ut ex blandit, elementum erat eget, pulvinar sapien. Donec nec lorem eu nunc eleifend tempor at non tortor. In quam velit, ornare at rutrum ac, porta ac augue. Suspendisse venenatis semper lacus at venenatis. Praesent vestibulum ligula nulla, at tempus lorem consequat suscipit. Aenean consequat dapibus dui, at bibendum mauris porta a.
+Morbi lorem libero, imperdiet id condimentum ac, tempor ut velit. Integer a laoreet sem. Nunc at sagittis nisi. Sed placerat diam eu porttitor dignissim. Maecenas nec fringilla tortor. Pellentesque ut elit est. Curabitur quis elit at mauris ullamcorper fringilla. Nullam diam mi, porttitor dictum orci nec, molestie luctus metus. Nunc ut ex blandit, elementum erat eget, pulvinar sapien. Donec nec lorem eu nunc eleifend tempor at non tortor. In quam velit, ornare at rutrum ac, porta ac augue. Suspendisse venenatis semper lacus at venenatis. Praesent vestibulum ligula nulla, at tempus lorem consequat suscipit. Aenean consequat dapibus dui, at bibendum mauris porta a.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc ex mi, elementum et ante commodo, semper sollicitudin magna. Sed dapibus ut tortor quis varius. Sed luctus sem at nunc porta vulputate. Suspendisse lobortis arcu est, quis ultrices ipsum fermentum a. Vestibulum a ipsum placerat ligula gravida fringilla at id ex. Etiam pellentesque lorem sed sagittis aliquam. Quisque semper orci risus, vel efficitur dui euismod aliquet. Morbi sapien sapien, rhoncus et rutrum nec, rhoncus id nisl. Cras non tincidunt enim, id eleifend neque.
-Morbi lorem libero, imperdiet id condimentum ac, tempor ut velit. Integer a laoreet sem. Nunc at sagittis nisi. Sed placerat diam eu porttitor dignissim. Maecenas nec fringilla tortor. Pellentesque ut elit est. Curabitur quis elit at mauris ullamcorper fringilla. Nullam diam mi, porttitor dictum orci nec, molestie luctus metus. Nunc ut ex blandit, elementum erat eget, pulvinar sapien. Donec nec lorem eu nunc eleifend tempor at non tortor. In quam velit, ornare at rutrum ac, porta ac augue. Suspendisse venenatis semper lacus at venenatis. Praesent vestibulum ligula nulla, at tempus lorem consequat suscipit. Aenean consequat dapibus dui, at bibendum mauris porta a.
-