Format Bytes

<cs-format-bytes>

Stable

Since 0.1

Formats a number of bytes as a human-readable string with the appropriate unit, such as kB, MB, or GB. Supports both byte and bit units with configurable locale.

The file is in size.

<div class="format-bytes-overview">
  The file is <cs-format-bytes value="1000"></cs-format-bytes> in size.

  <cs-divider></cs-divider>

  <cs-input type="number" value="1000" label="Number to Format" style="max-width: 180px;"></cs-input>
</div>

<script>
  const container = document.querySelector('.format-bytes-overview');
  const formatter = container.querySelector('cs-format-bytes');
  const input = container.querySelector('cs-input');

  input.addEventListener('input', () => (formatter.value = input.value || 0));
</script>

Examples

Bytes

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

<cs-format-bytes value="12"></cs-format-bytes><br />
<cs-format-bytes value="1200"></cs-format-bytes><br />
<cs-format-bytes value="1200000"></cs-format-bytes><br />
<cs-format-bytes value="1200000000"></cs-format-bytes>

Bits

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

<cs-format-bytes value="12" unit="bit"></cs-format-bytes><br />
<cs-format-bytes value="1200" unit="bit"></cs-format-bytes><br />
<cs-format-bytes value="1200000" unit="bit"></cs-format-bytes><br />
<cs-format-bytes value="1200000000" unit="bit"></cs-format-bytes>

Localization

Use the lang attribute to set the number formatting locale.

<cs-format-bytes value="12" lang="de"></cs-format-bytes><br />
<cs-format-bytes value="1200" lang="de"></cs-format-bytes><br />
<cs-format-bytes value="1200000" lang="de"></cs-format-bytes><br />
<cs-format-bytes value="1200000000" lang="de"></cs-format-bytes>

API

Importing

If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick this component, use one of the following snippets.

npm

Self-Hosted

React

import '@cruglobal/cornerstone-components/components/format-bytes/format-bytes.js';

import './cornerstone/components/format-bytes/format-bytes.js';

import CsFormatBytes from '@cruglobal/cornerstone-components/react/format-bytes/index.js';

Attributes & Properties

Learn more about attributes and properties.

Property	Attribute	Description	Type	Default	Reflects
`display`	`display`	Determines how to display the result, e.g. "100 bytes", "100 b", or "100b".	`'long' \| 'short' \| 'narrow'`	`'short'`	—
`unit`	`unit`	The type of unit to display.	`'byte' \| 'bit'`	`'byte'`	—
`value`	`value`	The number to format in bytes.	`number`	`0`	—

Quick Links

Recent Searches