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

doc: refactors props for multiple component documentation in storybook #2370

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@
:styles="styles"
>
<slot></slot>
<slot name="separator"></slot>
</scale-breadcrumb>
</template>

<script>
export default {
props: {
separator: String,
separator: { type: String},
styles: { type: String }
},
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
:value="value"
:variant="variant"
:icon-only="iconOnly"
:icon-position="iconPosition"
:inner-tabindex="innerTabindex"
:inner-aria-label="innerAriaLabel"
:styles="styles"
Expand All @@ -36,6 +37,7 @@ export default {
variant: String,
size: String,
iconOnly: Boolean,
iconPosition: String,
innerTabindex: Number,
innerAriaLabel: String,
styles: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,26 @@ import ScaleCheckboxGroup from './ScaleCheckboxGroup.vue';
argTypes={{}}
/>

export const Template = (args, { argTypes }) => ({
components: { ScaleCheckboxGroup },
props: ScaleCheckboxGroup.props,
template: `
<scale-checkbox-group
:name="name"
:label="label"
:helper-text="helperText"
:aria-label-checkbox-group="ariaLabelCheckboxGroup"
:invalid="invalid"
:select-text="selectText"
:unselect-text="unselectText"
:value="value"
:input-id="inputId"
:styles="styles"
:status="status"
></scale-checkbox-group>
`,
});

<div
style={{
display: 'inline-flex',
Expand All @@ -28,7 +48,9 @@ import ScaleCheckboxGroup from './ScaleCheckboxGroup.vue';
## Standard

<Canvas withSource="none">
<Story name="Standard" args={{}}>
<Story
name="Standard"
args={{}}>
{() => ({
template: `
<scale-checkbox-group label="Group Label" name="group" value="">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
<template>
<div>
<!-- this has the slots show up in ArgsTable -->
<scale-checkbox-group>
:name="name"
:label="label"
:helper-text="helperText"
:aria-label-checkbox-group="ariaLabelCheckboxGroup"
:invalid="invalid"
:select-text="selectText"
:unselect-text="unselectText"
:value="value"
:input-id="inputId"
:styles="styles"
:status="status"
<slot></slot>
</div>
</scale-checkbox-group>
</template>

<script>
Expand All @@ -11,14 +21,14 @@ export default {
name: { type: String },
label: { type: String, default: '' },
helperText: { type: String },
ariaLabelCheckboxGroup: { type: String },
ariaLabelCheckboxGroup: { type: String, default: 'COMMENT: ariaLabelCheckboxGroup should replace ariaLabel' },
invalid: { type: Boolean },
selectText: { type: String, default: 'Select all' },
unselectText: { type: String, default: 'Unselect all' },
value: { type: String, default: '' },
inputId: { type: String },
styles: { type: String },
status: { type: String, default: 'COMMENT: DEPRECATED - invalid should replace status'}
},
};
</script>
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,15 @@ import {
import ScaleCheckbox from './ScaleCheckbox.vue';
import { action } from '@storybook/addon-actions';

<Meta title="Components/Checkbox" component={ScaleCheckbox} argTypes={{}} />
<Meta
title="Components/Checkbox"
component={ScaleCheckbox}
argTypes={{
status: {
description: 'DEPRECATED - invalid should replace status'
}
}}
/>

export const Template = (args, { argTypes }) => ({
props: {
Expand All @@ -27,6 +35,9 @@ export const Template = (args, { argTypes }) => ({
:value="value"
:input-id="inputId"
:required="required"
:hide-label="hideLabel"
:status="status"
:styles="styles"
@scaleChange="action('scaleChange')($event)"
@scale-change="action('scale-change')($event)"
></scale-checkbox>
Expand Down Expand Up @@ -68,9 +79,8 @@ export const Template = (args, { argTypes }) => ({
```css
scale-checkbox {
--spacing-x: var(--telekom-spacing-composition-space-04);
--transition: all var(--telekom-motion-duration-transition) var(
--telekom-motion-easing-standard
);
--transition: all var(--telekom-motion-duration-transition)
var(--telekom-motion-easing-standard);
--color-text: var(--telekom-color-text-and-icon-standard);
--color-error: var(--telekom-color-functional-danger-standard);
--color-disabled: var(--telekom-color-text-and-icon-disabled);
Expand Down Expand Up @@ -255,4 +265,4 @@ scale-checkbox {
></scale-icon-alert-imprint-dataprivacy>
</span>
</scale-checkbox>
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
:input-id="inputId"
:required="required"
:aria-label-checkbox="ariaLabelCheckbox"
:hide-label="hideLabel"
:status="status"
:styles="styles"
@scaleChange="scaleChange"
>
</scale-checkbox>
Expand All @@ -33,6 +36,9 @@ export default {
required: { type: Boolean },
ariaLabelCheckbox: { type: String },
ariaDetailsId: { type: String },
hideLabel: { type: Boolean},
status: { type: String },
styles: { type: String },
},
methods: {
scaleChange($event) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ import { action } from '@storybook/addon-actions';
disabled: {
description: `only valid for persistent type`,
},
ariaCheckedState :{
description: ' DEPRECATED - (optional) chip aria-checked - should be derived from selected state attribute'
}
}}
/>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
:aria-role-title="ariaRoleTitle"
:disabled="disabled"
:styles="styles"
:label="label"
:dismiss-text="dismissText"
@scaleChange="scaleChange"
@scaleClose="scaleClose"
>
Expand All @@ -26,6 +28,8 @@ export default {
styles: { type: 'switch' | 'radio' | 'option' | 'menuitemreadio' | 'menuitemcheckbox' | 'checkbox', default: 'switch'},
ariaRoleTitle: { type: String },
ariaCheckedState: { type: Boolean },
label: { type: String },
dismissText: { type: String },
},
methods: {
scaleChange($event) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@ import ScaleDataGrid from './ScaleDataGrid.vue';
description: `(optional) Freeze header row from scrolling`,
control: { type: null },
},
visible: {
table: {
type: { summary: 'boolean' },
defaultValue: { summary: true },
},
description: `(optional) Set to false to hide table, used for nested tables to re-render upon toggle`,
control: { type: null },
},
heading: {
table: {
type: { summary: 'string' },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ import { action } from '@storybook/addon-actions';
description: `(optional) DEPRECATED - css overwrite should replace size`,
control: { type: null },
},
popupTitle: {
description: 'DEPRECATED - in v3 in favor of localization.calendarHeading'
},
status: {
description: 'DEPRECATED - invalid should replace status'
},
}}
/>

Expand All @@ -45,6 +51,9 @@ export const Template = (args, { argTypes }) => ({
:helper-text="helperText"
:invalid="invalid"
:placeholder="placeholder"
:inner-role="innerRole"
:status="status"
:variant="variant"
@scaleChange="scaleChange"
@scale-change="scale-change"
@scaleFocus="scaleFocus"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
:popup-title="popupTitle"
:placeholder="placeholder"
:styles="styles"
:inner-role="innerRole"
:status="status"
:variant="variant"
@scaleChange="scaleChange"
@scaleFocus="scaleFocus"
@scaleBlur="scaleBlur"
Expand Down Expand Up @@ -51,6 +54,9 @@ export default {
placeholder: { type: String },
size: { type: String },
ariaDetailsId: { type: String },
innerRole: { type: String },
status: { type: String },
variant: { type: 'informational' | 'warning' | 'danger' | 'success' | 'informational'},
},
methods: {
scaleChange($event) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ export const Template = (args, { argTypes }) => ({
:combobox-id="comboboxId"
:hide-label-visually="hideLabelVisually"
:floating-strategy="floatingStrategy"
:read-only="readOnly"
:transparent="transparent"
:aria-label-selected="ariaLabelSelected"
:hcm-label-disabled="hcmLabelDisabled"
@scaleChange="['scale-change']"
@scaleFocus="['scale-focus']"
@scaleBlur="['scale-blur']"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
:combobox-id="comboboxId"
:hide-label-visually="hideLabelVisually"
:floating-strategy="floatingStrategy"
:read-only="readOnly"
:transparent="transparent"
:aria-label-selected="ariaLabelSelected"
:hcm-label-disabled="hcmLabelDisabled"
@scaleChange="['scale-change']"
@scaleFocus="['scale-focus']"
@scaleBlur="['scale-blur']"
Expand All @@ -36,6 +40,10 @@ export default {
hideLabelVisually: { type: Boolean, default: false },
floatingStrategy: { type: String },
ariaDetailsId: { type: String },
readOnly: { type: Boolean },
transparent: { type: Boolean },
ariaLabelSelected: { type: String },
hcmLabelDisabled: { type: String },
Copy link
Collaborator

Choose a reason for hiding this comment

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

we can also add the description for these attributes here :
e.g. for hcmLabelDisabled
https://github.com/telekom/scale/blob/main/packages/components/src/components/dropdown-select/readme.md?plain=1#L17

},
methods: {
'scale-change'($event) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -274,9 +274,6 @@ The display error is on the browser side.
<option value="1">item 1</option>
<option value="2" selected>item 2</option>
<option value="3">item 3</option>
<scale-icon-content-calendar
size="20"
slot="icon"
></scale-icon-content-calendar>
<scale-icon-content-calendar size="20" slot="icon"></scale-icon-content-calendar>
</scale-dropdown>
```
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ import ScaleMenuFlyout from './ScaleMenuFlyout.vue';
description:
'Determines whether the dropdown should close when a menu item is selected',
},
triggerHasPopup: {
control: {
type: 'boolean',
},
description:
'Determines whether the flyout trigger should get the aria-haspopup attribute ',
},
}}
/>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
closeOnSelect: { type: Boolean, default: true },
direction: { type: String, default: 'bottom-right' },
styles: { type: String },
triggerHasPopup: { type: Boolean, default: true}
},
methods: {
emit() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,7 @@ export const PATH =
control: {
type: 'text',
},
},
styles: {
control: { disable: true },
},
}
}}
Copy link
Collaborator

Choose a reason for hiding this comment

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

add the style here again since without it the component is not working correctly

/>

Expand Down
2 changes: 0 additions & 2 deletions packages/storybook-vue/stories/components/icon/ScaleIcon.vue
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@
:focusable="focusable"
:decorative="decorative"
:accessibility-title="accessibilityTitle"
:styles="styles"
Copy link
Collaborator

Choose a reason for hiding this comment

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

add the style back here to make the storybook work

/>
</div>
</template>
Expand All @@ -55,7 +54,6 @@ export default {
focusable: { type: Boolean, default: false },
decorative: { type: Boolean, default: false },
accessibilityTitle: { type: String },
styles: { type: String }
Copy link
Collaborator

Choose a reason for hiding this comment

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

add the style back here to make the storybook work

}
}
</script>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
:logo-title="logoTitle"
:logo-hide-title="logoHideTitle"
:logo-aria-described-by="logoAriaDescribedBy"
:logo-aria-hidden="logoAriaHidden"
:accessibility-title="accessibilityTitle"
:focusable="focusable"
:scroll-into-view-on-focus="scrollIntoViewOnFocus"
Expand Down Expand Up @@ -42,8 +43,10 @@ export default {
href: { type: String },
styles: { type: String },
logoAriaDescribedBy: { type: String },
logoAriaHidden: { type: Boolean },
logoTitle: { type: String },
logoHideTitle: { type: Boolean },
accessibilityTitle: { type: String },
},
};
</script>
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@ export const Template = (args, context) => ({
<scale-modal
:heading="heading"
:size="size"
:variant="size"
:opened="isOpen"
:duration="duration"
:close-button-label="closeButtonLabel"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
<scale-modal
:heading="heading"
:size="size"
:variant="size"
:opened="opened"
:duration="duration"
:close-button-label="closeButtonLabel"
Expand Down Expand Up @@ -30,7 +29,6 @@ export default {
props: {
heading: { type: String, default: 'Today is your lucky day' },
size: String,
variant: String,
opened: Boolean,
duration: { type: Number, default: 200 },
closeButtonLabel: String,
Expand Down
Loading