kopia lustrzana https://github.com/shoelace-style/shoelace
155 wiersze
3.6 KiB
Markdown
155 wiersze
3.6 KiB
Markdown
# Progress Ring
|
|
|
|
[component-header:sl-progress-ring]
|
|
|
|
Progress rings are used to show the progress of a determinate operation in a circular fashion.
|
|
|
|
```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 Width
|
|
|
|
Use the `--track-width` custom property to set the width of the progress ring's track.
|
|
|
|
```html preview
|
|
<sl-progress-ring value="50" style="--track-width: 10px;"></sl-progress-ring>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlProgressRing } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => <SlProgressRing value="50" style={{ '--track-width': '10px' }} />;
|
|
```
|
|
|
|
### 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"></sl-icon></sl-button>
|
|
<sl-button circle><sl-icon name="plus"></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" />
|
|
</SlButton>
|
|
|
|
<SlButton circle onClick={() => adjustValue(10)}>
|
|
<SlIcon name="plus" />
|
|
</SlButton>
|
|
</>
|
|
);
|
|
};
|
|
```
|
|
|
|
[component-metadata:sl-progress-ring]
|