Skip to content

Improve typing of text-format #102

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Improve typing of text-format #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fddd7ab
improve typing of text-format
bristermitten Aug 14, 2025
29fdfe4
fix dependency issue
bristermitten Aug 14, 2025
d572e9a
use dayjs.ConfigType
bristermitten Aug 14, 2025
d30af79
fix eslint error
bristermitten Aug 14, 2025
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
8 changes: 8 additions & 0 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.

1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
},
"devDependencies": {
"@testing-library/react": "^16.1.0",
"@types/numeral": "^2.0.5",
"@types/react": "^18.3.14",
"@types/react-dom": "^18.3.2",
"@types/sanitize-html": "^2.13.0",
Expand Down
20 changes: 14 additions & 6 deletions src/formatter/text-format.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,28 @@ import dayjs from 'dayjs';
import TranslatorContext from '../language/translator-context';
import 'numeral/locales';

export type ITextFormatTypes = 'date' | 'number';

export interface ITextFormatProps {
value: string | number | Date;
type: ITextFormatTypes;
interface CommonTextFormatProps {
format?: string;
blankOnInvalid?: boolean;
locale?: string;
}

interface ITextFormatDateProps extends CommonTextFormatProps {
value: dayjs.ConfigType;
type: 'date';
}

interface ITextFormatNumberProps extends CommonTextFormatProps {
value: number | string;
type: 'number';
}

export type ITextFormatProps = ITextFormatDateProps | ITextFormatNumberProps;

/**
* Formats the given value to specified type like date or number.
* @param value value to be formatted
* @param type type of formatting to use ${ITextFormatTypes}
* @param type type of formatting to use (`date` or `number`)
* @param format optional format to use.
* For date type dayjs(https://day.js.org/docs/en/display/format) format is used
* For number type NumeralJS (http://numeraljs.com/#format) format is used
Expand Down