Format Bytes

sl-format-bytes

Formats a number as a human readable bytes value.

Examples

Byte Formatter Basics

The file is in size.

<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>

div.format-bytes-overview
  | The file is
  sl-format-bytes value="1000"
  | in size.
  br
  br
  sl-input type="number" value="1000" label="Number to Format" style="max-width: 180px;"

javascript:
  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));

Formatting Bytes

Set the value attribute to a number to get the value in bytes.

<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>

sl-format-bytes value="12"
br
sl-format-bytes value="1200"
br
sl-format-bytes value="1200000"
br
sl-format-bytes value="1200000000"

Formatting Bits

To get the value in bits, set the unit attribute to bit.

<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>

sl-format-bytes value="12" unit="bit"
br
sl-format-bytes value="1200" unit="bit"
br
sl-format-bytes value="1200000" unit="bit"
br
sl-format-bytes value="1200000000" unit="bit"

Localization

Use the lang attribute to set the number formatting locale.

<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>

sl-format-bytes value="12" lang="de"
br
sl-format-bytes value="1200" lang="de"
br
sl-format-bytes value="1200000" lang="de"
br
sl-format-bytes value="1200000000" lang="de"

Component Props

Property	Default	Details
`value`	`0`	`number` The number to format in bytes.
`unit`	`'byte'`	`'byte' \| 'bit'` The type of unit to display.
`display`	`'short'`	`'long' \| 'short' \| 'narrow'` Determines how to display the result, e.g. “100 bytes”, “100 b”, or “100b”.
`updateComplete`		A read-only promise that resolves when the component has finished updating.

Learn more about attributes and properties.