Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow custom scales and decimals to be set for DataSize #84

Merged
merged 2 commits into from
Nov 16, 2023
Merged

Allow custom scales and decimals to be set for DataSize #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3e748a
allow custom scales and decimals to be set
steppy452 Nov 16, 2023
a61a7ad
run npm audit fix
steppy452 Nov 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 41 additions & 0 deletions src/data/DataSize/DataSize.story.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,47 @@ export const Simple = () => (
<DataSize value="434334434123" />
<br />
<DataSize value={324344535345232} />
<br />
<DataSize value={324344535345232482} />
<br />
<DataSize value={324344535345232482281} />
<br />
<DataSize value={32434453534523248228135} />
<br />
<DataSize value={32434453534523248228123412} />
</Fragment>
);

export const CustomScale = () => {
const scale = ['b', 'kb', 'mb', 'gb', 'tb', 'pb', 'eb', 'zb', 'yb'];
return (
<Fragment>
<DataSize value="99" scale={scale} />
<br />
<DataSize value="4500" scale={scale} />
<br />
<DataSize value="34343233" scale={scale} />
<br />
<DataSize value="434334434123" scale={scale} />
<br />
<DataSize value={324344535345232} scale={scale} />
<br />
<DataSize value={324344535345232482} scale={scale} />
<br />
<DataSize value={324344535345232482281} scale={scale} />
<br />
<DataSize value={32434453534523248228135} scale={scale} />
<br />
<DataSize value={32434453534523248228123412} scale={scale} />
</Fragment>
);
};

export const CustomDecimals = () => (
<Fragment>
<DataSize value={34343233} decimals={0} />
<br />
<DataSize value={34343233} decimals={5} />
</Fragment>
);

Expand Down
19 changes: 16 additions & 3 deletions src/data/DataSize/DataSize.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,21 @@ export interface DataSizeProps {
* If the value is undefined/null it will return this value.
*/
emptyValue?: string;

/**
* Customize scale for displaying units.
*/
scale?: string[];

/**
* The number of decimals to be set.
*/
decimals?: number;
}

export const DataSize: FC<DataSizeProps> = ({ value, emptyValue }) => (
<>{formatSize(value, emptyValue)}</>
);
export const DataSize: FC<DataSizeProps> = ({
value,
emptyValue,
scale,
decimals
}) => <>{formatSize(value, emptyValue, scale, decimals)}</>;
13 changes: 11 additions & 2 deletions src/data/DataSize/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,23 @@ import humanFormat from 'human-format';

export type FormatSizeTypes = number | string | null | undefined;

export function formatSize(size: FormatSizeTypes, emptyValue = 'N/A') {
export function formatSize(
size: FormatSizeTypes,
emptyValue = 'N/A',
scale = ['B', 'KiB', 'MiB', 'GiB', 'TiB', 'PiB', 'EiB', 'ZiB', 'YiB'],
decimals = 2
) {
let newSize = size;
var binaryScale = humanFormat.Scale.create(scale, 1024);

if (typeof size === 'string') {
newSize = parseFloat(size as string);
} else if (size === null || size === undefined) {
return [emptyValue];
}

return humanFormat.bytes(newSize as number);
return humanFormat(newSize as number, {
scale: binaryScale,
decimals
});
}