@synerise/ds-format-picker 1.1.23 → 1.1.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/README.md +26 -21
  3. package/package.json +12 -12
package/CHANGELOG.md CHANGED
@@ -3,6 +3,10 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [1.1.24](https://github.com/Synerise/synerise-design/compare/@synerise/ds-format-picker@1.1.23...@synerise/ds-format-picker@1.1.24) (2026-03-20)
7
+
8
+ **Note:** Version bump only for package @synerise/ds-format-picker
9
+
6
10
  ## [1.1.23](https://github.com/Synerise/synerise-design/compare/@synerise/ds-format-picker@1.1.22...@synerise/ds-format-picker@1.1.23) (2026-03-09)
7
11
 
8
12
  **Note:** Version bump only for package @synerise/ds-format-picker
package/README.md CHANGED
@@ -37,31 +37,36 @@ import FormatPicker from '@synerise/ds-format-picker'
37
37
 
38
38
  ## API
39
39
 
40
- | Property | Description | Type | Default |
41
- | ---------------------- | ------------------------------ | ---------------------------------- | ------- |
42
- | format | Format configuration | FormattingValue | - |
43
- | value | Example value | number | - |
44
- | onDataFormatChange | Data format change handler | (format) => void} | - |
45
- | onCurrencyChange | Currency change handler | (currency: CurrencyType) => void | - |
46
- | onUseSeparatorChange | Use separator change handler | (useSeparator: boolean) => void} | - |
47
- | onCompactNumbersChange | Compact numbers change handler | (compactNumbers: boolean) => void} | - |
48
- | onFixedLengthChange | Fixed length change handler | (fixedLength) => void | - |
49
- | onSetDefault | Set default value of format | () => void | - |
50
- | text | Set of custom labels | Texts | - |
51
- | buttonType | type of button | string | - |
40
+ | Property | Description | Type | Default |
41
+ | ---------------------- | ------------------------------------------------------ | ------------------------------------------- | --------------- |
42
+ | format | Current format configuration | `FormattingValue` | - |
43
+ | value | Example number shown in the trigger button label | `number` | - |
44
+ | onDataFormatChange | Called when user selects a data format | `(format: FormattingDataFormat) => void` | - |
45
+ | onCurrencyChange | Called when a currency is selected | `(currency: CurrencyType) => void` | - |
46
+ | onUseSeparatorChange | Called when the 1000-separator checkbox changes | `(useSeparator: boolean) => void` | - |
47
+ | onCompactNumbersChange | Called when the compact numbers checkbox changes | `(compactNumbers: boolean) => void` | - |
48
+ | onFixedLengthChange | Called when decimal places are incremented/decremented | `(fixedLength: number) => void` | - |
49
+ | onSetDefault | If provided, renders a "Set default" footer button | `() => void` | - |
50
+ | onFormattedValueChange | Called whenever the formatted display value changes | `(formattedValue: string) => void` | - |
51
+ | text | Override any subset of UI labels | `Partial<FormatPickerTexts>` | - |
52
+ | currenciesConfig | Custom currency list for the cash dropdown | `CurrencyConfig[]` | USD/EUR/PLN/JPY |
53
+ | buttonType | DS button type for the trigger button | `string` | `'tertiary'` |
54
+ | disabled | Disables the trigger and all panel controls | `boolean` | - |
55
+ | maxFixedLength | Upper bound for decimal places | `number` | - |
52
56
 
53
57
  ### Texts
54
58
 
55
59
  | Property | Description | Type | Default |
56
60
  | -------------- | --------------------------------- | ------------------------ | -------------------- |
57
- | header | Header of format settings | string \ React.ReactNode | `Number format` |
58
- | format | Format label | string \ React.ReactNode | `Format` |
59
- | numeric | Numeric type of format tooltip | string \ React.ReactNode | `Numeric` |
60
- | cash | Cash type of format tooltip | string \ React.ReactNode | `Cash` |
61
- | percentage | Percentage type of format tooltip | string \ React.ReactNode | `Percentage` |
62
- | setDefault | Set default format button label | string \ React.ReactNode | `Set default` |
63
- | useSeparator | Use 1000 separator checkbox label | string \ React.ReactNode | `Use 1000 separator` |
64
- | compactNumbers | Compact number checkbox label | string \ React.ReactNode | `Compact humbers` |
61
+ | header | Header of format settings | `string \| ReactNode` | `Number format` |
62
+ | format | Format label | `string \| ReactNode` | `Format` |
63
+ | numeric | Numeric type of format tooltip | `string \| ReactNode` | `Numeric` |
64
+ | cash | Cash type of format tooltip | `string \| ReactNode` | `Cash` |
65
+ | percentage | Percentage type of format tooltip | `string \| ReactNode` | `Percentage` |
66
+ | setDefault | Set default format button label | `string \| ReactNode` | `Set default` |
67
+ | useSeparator | Use 1000 separator checkbox label | `string \| ReactNode` | `Use 1000 separator` |
68
+ | compactNumbers | Compact numbers checkbox label | `string \| ReactNode` | `Use compact numbers` |
69
+ | currencyMenuItemPrefix | Prefix shown before the example value in currency rows | `string` | `'e.g.'` |
65
70
 
66
71
  ### FormattingValue
67
72
 
@@ -75,7 +80,7 @@ import FormatPicker from '@synerise/ds-format-picker'
75
80
 
76
81
  ### CurrencyType
77
82
 
78
- Available values: `USD` | `EUR` | `PLN` | `JPY`
83
+ `string` — any currency code string. The default `currenciesConfig` includes `USD`, `EUR`, `PLN`, `JPY`, but the type is not restricted to those values.
79
84
 
80
85
  ### FormattingDataFormat
81
86
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@synerise/ds-format-picker",
3
- "version": "1.1.23",
3
+ "version": "1.1.24",
4
4
  "description": "FormatPicker UI Component for the Synerise Design System",
5
5
  "license": "ISC",
6
6
  "repository": "Synerise/synerise-design",
@@ -35,16 +35,16 @@
35
35
  ],
36
36
  "types": "dist/index.d.ts",
37
37
  "dependencies": {
38
- "@synerise/ds-button": "^1.5.16",
39
- "@synerise/ds-button-group": "^1.1.41",
40
- "@synerise/ds-checkbox": "^1.2.19",
41
- "@synerise/ds-dropdown": "^1.3.0",
42
- "@synerise/ds-icon": "^1.14.1",
43
- "@synerise/ds-list-item": "^1.4.8",
44
- "@synerise/ds-radio": "^1.1.1",
45
- "@synerise/ds-tooltip": "^1.4.8",
46
- "@synerise/ds-typography": "^1.1.11",
47
- "@synerise/ds-utils": "^1.6.0"
38
+ "@synerise/ds-button": "^1.5.17",
39
+ "@synerise/ds-button-group": "^1.1.42",
40
+ "@synerise/ds-checkbox": "^1.2.20",
41
+ "@synerise/ds-dropdown": "^1.3.1",
42
+ "@synerise/ds-icon": "^1.15.0",
43
+ "@synerise/ds-list-item": "^1.4.9",
44
+ "@synerise/ds-radio": "^1.1.2",
45
+ "@synerise/ds-tooltip": "^1.4.9",
46
+ "@synerise/ds-typography": "^1.1.12",
47
+ "@synerise/ds-utils": "^1.7.0"
48
48
  },
49
49
  "peerDependencies": {
50
50
  "@synerise/ds-core": "*",
@@ -52,5 +52,5 @@
52
52
  "react-intl": ">=3.12.0 <= 6.8",
53
53
  "styled-components": "^5.3.3"
54
54
  },
55
- "gitHead": "8dfafc5d7278f09d430f1e7499782d05c76b47c0"
55
+ "gitHead": "8efc031fa688c0b87c7b3915bae93546bb63bcac"
56
56
  }