Skip to content

Commit 62af26a

Browse files
kennylam2nikhiltom
authored andcommitted
chore(docs): update misc web component Storybook docs (carbon-design-system#19223)
* chore(docs): update slider wc sb docs * chore(docs): update structured list wc sb docs * chore(docs): remove skip-to-content story and docs --------- Co-authored-by: Nikhil Tomar <[email protected]>
1 parent 264a7b0 commit 62af26a

File tree

9 files changed

+119
-326
lines changed

9 files changed

+119
-326
lines changed

packages/react/src/components/Slider/Slider.mdx

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ import { stackblitzPrefillConfig } from '../../../previewer/codePreviewer';
1818
- [Overview](#overview)
1919
- [Controlled Slider](#controlled-slider)
2020
- [Skeleton](#skeleton)
21-
- [Slider With Customer](#slider-with-customer)
22-
- [Slider With Hidden Inputs](#slider-with-customer)
21+
- [Slider With Custom Value](#slider-with-custom-value)
22+
- [Slider With Hidden Inputs](#slider-with-hidden-inputs)
2323
- [Two Handle Skeleton](#two-handle-skeleton)
2424
- [Two Handle Slider](#two-handle-slider)
2525
- [Two Handle Slider With Hidden Inputs](#two-handle-slider-with-hidden-inputs)
@@ -65,14 +65,15 @@ increase or decrease the value by moving the handle along a horizontal track.
6565
]}
6666
/>
6767

68-
## Slider With Customer
68+
## Slider With Custom Value
6969

7070
<Canvas
7171
of={SliderStories.SliderWithCustomValueLabel}
7272
additionalActions={[
7373
{
7474
title: 'Open in Stackblitz',
75-
onClick: () => stackblitzPrefillConfig(SliderStories.SliderWithCustomValueLabel),
75+
onClick: () =>
76+
stackblitzPrefillConfig(SliderStories.SliderWithCustomValueLabel),
7677
},
7778
]}
7879
/>
@@ -84,7 +85,8 @@ increase or decrease the value by moving the handle along a horizontal track.
8485
additionalActions={[
8586
{
8687
title: 'Open in Stackblitz',
87-
onClick: () => stackblitzPrefillConfig(SliderStories.SliderWithHiddenInputs),
88+
onClick: () =>
89+
stackblitzPrefillConfig(SliderStories.SliderWithHiddenInputs),
8890
},
8991
]}
9092
/>
@@ -135,7 +137,8 @@ keys to `onChange` function prop that is passed to the component.
135137
additionalActions={[
136138
{
137139
title: 'Open in Stackblitz',
138-
onClick: () => stackblitzPrefillConfig(SliderStories.TwoHandleSliderWithHiddenInputs),
140+
onClick: () =>
141+
stackblitzPrefillConfig(SliderStories.TwoHandleSliderWithHiddenInputs),
139142
},
140143
]}
141144
/>

packages/web-components/src/components/skip-to-content/skip-to-content-story.scss

Lines changed: 0 additions & 18 deletions
This file was deleted.

packages/web-components/src/components/skip-to-content/skip-to-content.mdx

Lines changed: 0 additions & 39 deletions
This file was deleted.

packages/web-components/src/components/skip-to-content/skip-to-content.stories.ts

Lines changed: 0 additions & 74 deletions
This file was deleted.
Lines changed: 36 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,59 @@
1-
import { ArgTypes, Meta, Markdown } from '@storybook/blocks';
2-
import { cdnJs, cdnCss } from '../../globals/internal/storybook-cdn';
1+
import { ArgTypes, Canvas, Markdown, Meta } from '@storybook/blocks';
2+
import { cdnJs } from '../../globals/internal/storybook-cdn';
33
import * as SliderStories from './slider.stories';
44

55
<Meta of={SliderStories} />
66

77
# Slider
88

9-
> 💡 Check our
10-
> [Stackblitz](https://stackblitz.com/github/carbon-design-system/carbon/tree/main/packages/web-components/examples/components/slider)
11-
> example implementation.
9+
[Source code](https://github.com/carbon-design-system/carbon/tree/main/packages/web-components/src/components/slider)
10+
&nbsp;|&nbsp;
11+
[Usage guidelines](https://www.carbondesignsystem.com/components/slider/usage)
12+
&nbsp;|&nbsp;
13+
[Accessibility](https://www.carbondesignsystem.com/components/slider/accessibility)
1214

13-
[![Edit carbon-web-components](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/carbon-design-system/carbon/tree/main/packages/web-components/examples/components/slider)
15+
## Table of Contents
1416

15-
Sliders provide a visual indication of adjustable content, where the user can
16-
move the handle along a horizontal track to increase or decrease the value.
17-
18-
## Getting started
19-
20-
Here's a quick example to get you started.
21-
22-
### JS (via import)
23-
24-
```javascript
25-
import '@carbon/web-components/es/components/slider/index.js';
26-
```
27-
28-
<Markdown>{`${cdnJs({ components: ['slider'] })}`}</Markdown>
29-
<Markdown>{`${cdnCss()}`}</Markdown>
17+
- [Overview](#overview)
18+
- [Controlled Slider](#controlled-slider)
19+
- [Skeleton](#skeleton)
20+
- [Slider With Customer](#slider-with-customer)
21+
- [Slider With Hidden Inputs](#slider-with-customer)
22+
- [Two Handle Skeleton](#two-handle-skeleton)
23+
- [Two Handle Slider](#two-handle-slider)
24+
- [Two Handle Slider With Hidden Inputs](#two-handle-slider-with-hidden-inputs)
25+
- [Component API](#component-api)
26+
- [Feedback](#feedback)
3027

31-
### HTML
28+
## Overview
3229

33-
```html
34-
<cds-slider
35-
label-text="Slider"
36-
max="100"
37-
min="0"
38-
step="1"
39-
value="50"></cds-slider>
40-
```
30+
Sliders provide a visual indication of adjustable content, where the user can
31+
increase or decrease the value by moving the handle along a horizontal track.
4132

42-
## With input box
33+
<Canvas of={SliderStories.Default} />
4334

44-
To include an input box, place `<cds-slider-input>` within `<cds-slider>`.
35+
## Controlled Slider
4536

46-
```html
47-
<cds-slider label-text="Slider" max="100" min="0" step="1" value="50">
48-
<cds-slider-input aria-label="Slider value" type="number"></cds-slider-input>
49-
</cds-slider>
50-
```
37+
<Canvas of={SliderStories.ControlledSlider} />
5138

5239
## Skeleton
5340

54-
For the skeleton variation, utilize `<cds-slider-skeleton>`.
55-
56-
```html
57-
<cds-slider-skeleton></cds-slider-skeleton>
58-
```
41+
<Canvas of={SliderStories.Skeleton} />
5942

60-
## `<cds-slider>` attributes, properties and events
43+
## Component API
6144

62-
Note: For `boolean` attributes, `true` means simply setting the attribute (e.g.
63-
`<cds-slider disabled>`) and `false` means not setting the attribute (e.g.
64-
`<cds-slider>` without `disabled` attribute).
45+
## `cds-slider`
6546

6647
<ArgTypes of="cds-slider" />
6748

68-
## `<cds-slider-input>` attributes, properties and events
69-
70-
Note: For `boolean` attributes, `true` means simply setting the attribute (e.g.
71-
`<cds-slider-input invalid>`) and `false` means not setting the attribute (e.g.
72-
`<cds-slider-input>` without `invalid` attribute).
49+
## `cds-slider-input`
7350

7451
<ArgTypes of="cds-slider-input" />
52+
53+
<Markdown>{`${cdnJs({ components: ['slider'] })}`}</Markdown>
54+
55+
## Feedback
56+
57+
Help us improve this component by providing feedback, asking questions on Slack,
58+
or updating this file on
59+
[GitHub](https://github.com/carbon-design-system/carbon/edit/main/packages/web-components/src/components/slider/slider.mdx).

packages/web-components/src/components/slider/slider.scss

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ $css--plex: true !default;
1212
@use '@carbon/styles/scss/components/slider';
1313
@use '@carbon/styles/scss/layout' as *;
1414

15-
:host(#{$prefix}-slider) {
15+
:host(#{$prefix}-slider),
16+
:host(#{$prefix}-slider-skeleton) {
1617
outline: none;
1718
@include emit-layout-tokens();
1819

@@ -53,3 +54,9 @@ $css--plex: true !default;
5354
background-color: transparent;
5455
}
5556
}
57+
58+
:host(#{$prefix}-slider-skeleton) {
59+
.#{$prefix}--slider__thumb {
60+
inset-inline-start: 50%;
61+
}
62+
}

packages/web-components/src/components/slider/slider.stories.ts

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -146,10 +146,8 @@ export const ControlledSlider = {
146146
let value = 87;
147147
function onClick() {
148148
value = Math.round(Math.random() * 100);
149-
const sliders = document.getElementsByTagName('cds-slider');
150-
for (const slider of sliders) {
151-
slider.setAttribute('value', `${value}`);
152-
}
149+
const slider = document.querySelector('cds-slider[controlled]');
150+
slider?.setAttribute('value', `${value}`);
153151

154152
const headers = document.getElementsByClassName('slider-headers');
155153
for (const header of headers) {
@@ -159,7 +157,12 @@ export const ControlledSlider = {
159157
return html`
160158
<button type="button" @click="${onClick}">randomize value</button>
161159
<cds-form-item>
162-
<cds-slider max="100" min="0" step="1" value="${ifDefined(value)}">
160+
<cds-slider
161+
controlled
162+
max="100"
163+
min="0"
164+
step="1"
165+
value="${ifDefined(value)}">
163166
<cds-slider-input
164167
aria-label="Slider value"
165168
type="number"></cds-slider-input>
@@ -232,7 +235,9 @@ export const Skeleton = {
232235
},
233236
},
234237
render: () => html`
235-
<cds-form-item><cds-slider-skeleton></cds-slider-skeleton></cds-form-item>
238+
<cds-form-item
239+
><cds-slider-skeleton><cds-slider></cds-slider></cds-slider-skeleton
240+
></cds-form-item>
236241
`,
237242
};
238243

0 commit comments

Comments
 (0)