mirror of
https://github.com/shoelace-style/shoelace.git
synced 2026-01-12 19:19:13 +00:00
8121faa1d4
* keep header styles with repositioned description text * `animated-image` move description to component * code style * `avatar` add summary from docs * `badge` add summary from docs * `breadcrumb` add summary from docs * `button` add summary from docs * lead sentence is now part of the header * `button-group` add summary from docs * `card` add summary from docs * `checkbox` add summary from docs * `color-picker` add summary from docs * `details` add summary from docs * `dialog` add summary from docs * `divider` add summary from docs * `drawer` add summary from docs * `dropdown` add summary from docs * `format-bytes` add summary from docs * `format-date` add summary from docs * `format-number` add summary from docs * `icon` add summary from docs * `icon-button` add summary from docs * `image-comparer` add summary from docs * `include` add summary from docs * `input` add summary from docs * `menu` add summary from docs * `menu-item` add summary from docs * `menu-label` add summary from docs * `popup` add summary from docs * `progressbar` add summary from docs * `progress-ring` add summary from docs * `radio` add summary from docs * `radio-button` add summary from docs * `range` add summary from docs * `rating` add summary from docs * `relative-time` add summary from docs * `select` add summary from docs * `skeleton` add summary from docs * `spinner` add summary from docs * `split-panel` add summary from docs * `switch` add summary from docs * `tab-group` add summary from docs * `tag` add summary from docs * `textarea` add summary from docs * `tooltip` add summary from docs * `visually-hidden` add summary from docs * `animation` add summary from docs * `breadcrumb-item` add summary from docs * `mutation-observer` add summary from docs * `radio-group` add summary from docs * `resize-observer` add summary from docs * `tab` add summary from docs * `tab-panel` add summary from docs * `tree` add summary from docs * `tree-item` add summary from docs * remove `title` for further usage of `Sl` classnames in docs * revert: use markdown parser for component summary
153 lines
3.7 KiB
Markdown
153 lines
3.7 KiB
Markdown
# Progress Ring
|
|
|
|
[component-header:sl-progress-ring]
|
|
|
|
```html preview
|
|
<sl-progress-ring value="25"></sl-progress-ring>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlProgressRing } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => <SlProgressRing value="25" />;
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Size
|
|
|
|
Use the `--size` custom property to set the diameter of the progress ring.
|
|
|
|
```html preview
|
|
<sl-progress-ring value="50" style="--size: 200px;"></sl-progress-ring>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlProgressRing } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => <SlProgressRing value="50" style={{ '--size': '200px' }} />;
|
|
```
|
|
|
|
### Track and Indicator Width
|
|
|
|
Use the `--track-width` and `--indicator-width` custom properties to set the width of the progress ring's track and indicator.
|
|
|
|
```html preview
|
|
<sl-progress-ring value="50" style="--track-width: 6px; --indicator-width: 12px;"></sl-progress-ring>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlProgressRing } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => <SlProgressRing value="50" style={{ '--track-width': '6px', '--indicator-width': '12px' }} />;
|
|
```
|
|
|
|
### Colors
|
|
|
|
To change the color, use the `--track-color` and `--indicator-color` custom properties.
|
|
|
|
```html preview
|
|
<sl-progress-ring
|
|
value="50"
|
|
style="
|
|
--track-color: pink;
|
|
--indicator-color: deeppink;
|
|
"
|
|
></sl-progress-ring>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlProgressRing } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<SlProgressRing
|
|
value="50"
|
|
style={{
|
|
'--track-color': 'pink',
|
|
'--indicator-color': 'deeppink'
|
|
}}
|
|
/>
|
|
);
|
|
```
|
|
|
|
### Labels
|
|
|
|
Use the `label` attribute to label the progress ring and tell assistive devices how to announce it.
|
|
|
|
```html preview
|
|
<sl-progress-ring value="50" label="Upload progress"></sl-progress-ring>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlProgressRing } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => <SlProgressRing value="50" label="Upload progress" />;
|
|
```
|
|
|
|
### Showing Values
|
|
|
|
Use the default slot to show a label inside the progress ring.
|
|
|
|
```html preview
|
|
<sl-progress-ring value="50" class="progress-ring-values" style="margin-bottom: .5rem;">50%</sl-progress-ring>
|
|
|
|
<br />
|
|
|
|
<sl-button circle><sl-icon name="dash" label="Decrease"></sl-icon></sl-button>
|
|
<sl-button circle><sl-icon name="plus" label="Increase"></sl-icon></sl-button>
|
|
|
|
<script>
|
|
const progressRing = document.querySelector('.progress-ring-values');
|
|
const subtractButton = progressRing.nextElementSibling.nextElementSibling;
|
|
const addButton = subtractButton.nextElementSibling;
|
|
|
|
addButton.addEventListener('click', () => {
|
|
const value = Math.min(100, progressRing.value + 10);
|
|
progressRing.value = value;
|
|
progressRing.textContent = `${value}%`;
|
|
});
|
|
|
|
subtractButton.addEventListener('click', () => {
|
|
const value = Math.max(0, progressRing.value - 10);
|
|
progressRing.value = value;
|
|
progressRing.textContent = `${value}%`;
|
|
});
|
|
</script>
|
|
```
|
|
|
|
```jsx react
|
|
import { useState } from 'react';
|
|
import { SlButton, SlIcon, SlProgressRing } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => {
|
|
const [value, setValue] = useState(50);
|
|
|
|
function adjustValue(amount) {
|
|
let newValue = value + amount;
|
|
if (newValue < 0) newValue = 0;
|
|
if (newValue > 100) newValue = 100;
|
|
setValue(newValue);
|
|
}
|
|
|
|
return (
|
|
<>
|
|
<SlProgressRing value={value} style={{ marginBottom: '.5rem' }}>
|
|
{value}%
|
|
</SlProgressRing>
|
|
|
|
<br />
|
|
|
|
<SlButton circle onClick={() => adjustValue(-10)}>
|
|
<SlIcon name="dash" label="Decrease" />
|
|
</SlButton>
|
|
|
|
<SlButton circle onClick={() => adjustValue(10)}>
|
|
<SlIcon name="plus" label="Increase" />
|
|
</SlButton>
|
|
</>
|
|
);
|
|
};
|
|
```
|
|
|
|
[component-metadata:sl-progress-ring]
|