mirror of
https://github.com/shoelace-style/webawesome.git
synced 2026-01-12 20: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
128 lines
3.1 KiB
Markdown
128 lines
3.1 KiB
Markdown
# Format Bytes
|
|
|
|
[component-header:sl-format-bytes]
|
|
|
|
```html preview
|
|
<div class="format-bytes-overview">
|
|
The file is <sl-format-bytes value="1000"></sl-format-bytes> in size. <br /><br />
|
|
<sl-input type="number" value="1000" label="Number to Format" style="max-width: 180px;"></sl-input>
|
|
</div>
|
|
|
|
<script>
|
|
const container = document.querySelector('.format-bytes-overview');
|
|
const formatter = container.querySelector('sl-format-bytes');
|
|
const input = container.querySelector('sl-input');
|
|
|
|
input.addEventListener('sl-input', () => (formatter.value = input.value || 0));
|
|
</script>
|
|
```
|
|
|
|
```jsx react
|
|
import { useState } from 'react';
|
|
import { SlButton, SlFormatBytes, SlInput } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => {
|
|
const [value, setValue] = useState(1000);
|
|
|
|
return (
|
|
<>
|
|
The file is <SlFormatBytes value={value} /> in size.
|
|
<br />
|
|
<br />
|
|
<SlInput
|
|
type="number"
|
|
value={value}
|
|
label="Number to Format"
|
|
style={{ maxWidth: '180px' }}
|
|
onSlInput={event => setValue(event.target.value)}
|
|
/>
|
|
</>
|
|
);
|
|
};
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Formatting Bytes
|
|
|
|
Set the `value` attribute to a number to get the value in bytes.
|
|
|
|
```html preview
|
|
<sl-format-bytes value="12"></sl-format-bytes><br />
|
|
<sl-format-bytes value="1200"></sl-format-bytes><br />
|
|
<sl-format-bytes value="1200000"></sl-format-bytes><br />
|
|
<sl-format-bytes value="1200000000"></sl-format-bytes>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlFormatBytes } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<>
|
|
<SlFormatBytes value="12" />
|
|
<br />
|
|
<SlFormatBytes value="1200" />
|
|
<br />
|
|
<SlFormatBytes value="1200000" />
|
|
<br />
|
|
<SlFormatBytes value="1200000000" />
|
|
</>
|
|
);
|
|
```
|
|
|
|
### Formatting Bits
|
|
|
|
To get the value in bits, set the `unit` attribute to `bit`.
|
|
|
|
```html preview
|
|
<sl-format-bytes value="12" unit="bit"></sl-format-bytes><br />
|
|
<sl-format-bytes value="1200" unit="bit"></sl-format-bytes><br />
|
|
<sl-format-bytes value="1200000" unit="bit"></sl-format-bytes><br />
|
|
<sl-format-bytes value="1200000000" unit="bit"></sl-format-bytes>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlFormatBytes } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<>
|
|
<SlFormatBytes value="12" unit="bit" />
|
|
<br />
|
|
<SlFormatBytes value="1200" unit="bit" />
|
|
<br />
|
|
<SlFormatBytes value="1200000" unit="bit" />
|
|
<br />
|
|
<SlFormatBytes value="1200000000" unit="bit" />
|
|
</>
|
|
);
|
|
```
|
|
|
|
### Localization
|
|
|
|
Use the `lang` attribute to set the number formatting locale.
|
|
|
|
```html preview
|
|
<sl-format-bytes value="12" lang="de"></sl-format-bytes><br />
|
|
<sl-format-bytes value="1200" lang="de"></sl-format-bytes><br />
|
|
<sl-format-bytes value="1200000" lang="de"></sl-format-bytes><br />
|
|
<sl-format-bytes value="1200000000" lang="de"></sl-format-bytes>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlFormatBytes } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<>
|
|
<SlFormatBytes value="12" lang="de" />
|
|
<br />
|
|
<SlFormatBytes value="1200" lang="de" />
|
|
<br />
|
|
<SlFormatBytes value="1200000" lang="de" />
|
|
<br />
|
|
<SlFormatBytes value="1200000000" lang="de" />
|
|
</>
|
|
);
|
|
```
|
|
|
|
[component-metadata:sl-format-bytes]
|