@emporix/component-library 1.11.0 → 1.12.1
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.
- package/README.md +7 -56
- package/dist/components/dropdown/Dropdown.d.ts +3 -3
- package/dist/components/dropdown/Dropdown.d.ts.map +1 -1
- package/dist/index.es.js +449 -447
- package/dist/index.umd.js +1 -1
- package/dist/style.css +1 -1
- package/package.json +1 -4
package/README.md
CHANGED
|
@@ -436,23 +436,23 @@ const options = [
|
|
|
436
436
|
| optionDisabled | string | - | Property name for disabled flag on options |
|
|
437
437
|
| placeholder | string | `"Select"` | Placeholder when no value selected |
|
|
438
438
|
| filter | boolean | false | Enable search filter in the overlay |
|
|
439
|
-
| editable | boolean | false | Allow typing in the
|
|
439
|
+
| editable | boolean | false | Allow typing in the control to filter/select |
|
|
440
440
|
| onEditEnd | (e: EditEndEvent) => void | - | Fired when Enter is pressed in editable mode |
|
|
441
441
|
| multiple | boolean | false | Allow multiple selection |
|
|
442
|
-
| display | `'comma' \| 'chip'` | `'comma'` | Multi-select
|
|
442
|
+
| display | `'comma' \| 'chip'` | `'comma'` | Multi-select control display mode |
|
|
443
443
|
| maxSelectedLabels | number | - | Max chips before showing `selectedItemsLabel` |
|
|
444
444
|
| selectedItemsLabel | string | `'{0} items selected'` | Overflow label; `{0}` = count |
|
|
445
445
|
| removeIcon | ReactNode | - | Custom icon for chip remove buttons |
|
|
446
|
-
| label | ReactNode | - | Label text above the
|
|
447
|
-
| error | ReactNode | - | Error text displayed below the
|
|
446
|
+
| label | ReactNode | - | Label text above the control |
|
|
447
|
+
| error | ReactNode | - | Error text displayed below the control |
|
|
448
448
|
| required | boolean | false | Shows asterisk on label |
|
|
449
|
-
| inputId | string | - | id for the
|
|
449
|
+
| inputId | string | - | id for the control (for label association) |
|
|
450
450
|
| disabled | boolean | false | Whether the dropdown is disabled |
|
|
451
|
-
| valueTemplate | (option) => ReactNode | - | Custom render for selected value in
|
|
451
|
+
| valueTemplate | (option) => ReactNode | - | Custom render for selected value in control |
|
|
452
452
|
| itemTemplate | (option) => ReactNode | - | Custom render for each option in the list |
|
|
453
453
|
| className | string | - | Additional CSS class for the root |
|
|
454
454
|
| panelClassName | string | - | Additional CSS class for the overlay panel |
|
|
455
|
-
| data-testid | string | - | Test ID for root,
|
|
455
|
+
| data-testid | string | - | Test ID for root, control, panel, and options |
|
|
456
456
|
|
|
457
457
|
### SelectButton
|
|
458
458
|
|
|
@@ -1005,7 +1005,6 @@ npm run storybook
|
|
|
1005
1005
|
- `npm run test:coverage` - Run tests with coverage
|
|
1006
1006
|
- `npm run storybook` - Start Storybook
|
|
1007
1007
|
- `npm run build-storybook` - Build Storybook
|
|
1008
|
-
- `npm run build:pages` - Build showcase and Storybook for GitHub Pages
|
|
1009
1008
|
- `npm run lint` - Run ESLint
|
|
1010
1009
|
- `npm run lint:fix` - Fix ESLint issues
|
|
1011
1010
|
- `npm run type-check` - Run TypeScript type checking
|
|
@@ -1055,54 +1054,6 @@ The build output includes:
|
|
|
1055
1054
|
- TypeScript declarations (`index.d.ts`)
|
|
1056
1055
|
- CSS styles (`styles.css`)
|
|
1057
1056
|
|
|
1058
|
-
## Publishing
|
|
1059
|
-
|
|
1060
|
-
Releases are automated via GitHub Actions when you push a version tag. Pushing a tag triggers:
|
|
1061
|
-
|
|
1062
|
-
1. **npm publish** — builds the library (`npm run build:lib`) and publishes `@emporix/component-library` to the npm registry
|
|
1063
|
-
2. **GitHub Pages** — builds the showcase app (`npm run dev`) and static Storybook, then deploys both sites
|
|
1064
|
-
|
|
1065
|
-
### Live sites
|
|
1066
|
-
|
|
1067
|
-
After a successful release:
|
|
1068
|
-
|
|
1069
|
-
| Site | URL |
|
|
1070
|
-
| ------------------ | ------------------------------------------------------ |
|
|
1071
|
-
| Showcase (dev app) | https://emporix.github.io/component-library/ |
|
|
1072
|
-
| Storybook | https://emporix.github.io/component-library/storybook/ |
|
|
1073
|
-
|
|
1074
|
-
### One-time setup
|
|
1075
|
-
|
|
1076
|
-
In the GitHub repository, go to **Settings → Pages** and set **Source** to **GitHub Actions**.
|
|
1077
|
-
|
|
1078
|
-
npm publishing uses [trusted publishing](https://docs.npmjs.com/trusted-publishers) (OIDC) — ensure the npm package is configured to trust this repository’s `publish.yml` workflow.
|
|
1079
|
-
|
|
1080
|
-
### Release steps
|
|
1081
|
-
|
|
1082
|
-
1. **Bump the version** in `package.json` (and `package-lock.json` via `npm install` if needed):
|
|
1083
|
-
- **Minor** (`1.7.1` → `1.8.0`) for backward-compatible features
|
|
1084
|
-
- **Major** (`1.7.1` → `2.0.0`) for breaking changes
|
|
1085
|
-
- **Patch** (`1.7.1` → `1.7.2`) for bug fixes only
|
|
1086
|
-
2. **Merge** the version bump to the default branch.
|
|
1087
|
-
3. **Create and push a tag** that matches `package.json` exactly (prefix with `v`):
|
|
1088
|
-
|
|
1089
|
-
```bash
|
|
1090
|
-
# Example: package.json version is 1.10.0
|
|
1091
|
-
git tag v1.10.0
|
|
1092
|
-
git push origin v1.10.0
|
|
1093
|
-
```
|
|
1094
|
-
|
|
1095
|
-
The tag must match the format `v{semver}` (e.g. `v1.2.3`). CI rejects tags that do not match `package.json`.
|
|
1096
|
-
|
|
1097
|
-
### Preview GitHub Pages locally
|
|
1098
|
-
|
|
1099
|
-
```bash
|
|
1100
|
-
npm run build:pages
|
|
1101
|
-
npx serve gh-pages
|
|
1102
|
-
```
|
|
1103
|
-
|
|
1104
|
-
Open http://localhost:3000/component-library/ (showcase) and http://localhost:3000/component-library/storybook/ (Storybook).
|
|
1105
|
-
|
|
1106
1057
|
## Code Formatting
|
|
1107
1058
|
|
|
1108
1059
|
This project uses Prettier for consistent code formatting. The configuration is defined in `.prettierrc`.
|
|
@@ -75,7 +75,7 @@ export interface DropdownProps<T = DropdownOption> {
|
|
|
75
75
|
*/
|
|
76
76
|
filter?: boolean;
|
|
77
77
|
/**
|
|
78
|
-
* When true, the
|
|
78
|
+
* When true, the control is an editable input: user can type to filter options
|
|
79
79
|
* and select from the list. Matches PrimeReact Dropdown editable behavior.
|
|
80
80
|
* @see https://primereact.org/dropdown/#editable
|
|
81
81
|
*/
|
|
@@ -98,7 +98,7 @@ export interface DropdownProps<T = DropdownOption> {
|
|
|
98
98
|
*/
|
|
99
99
|
label?: React.ReactNode;
|
|
100
100
|
/**
|
|
101
|
-
* Error text displayed below the
|
|
101
|
+
* Error text displayed below the control
|
|
102
102
|
*/
|
|
103
103
|
error?: React.ReactNode;
|
|
104
104
|
/**
|
|
@@ -114,7 +114,7 @@ export interface DropdownProps<T = DropdownOption> {
|
|
|
114
114
|
*/
|
|
115
115
|
panelClassName?: string;
|
|
116
116
|
/**
|
|
117
|
-
* Template for the selected value displayed in the
|
|
117
|
+
* Template for the selected value displayed in the control.
|
|
118
118
|
* Receives the selected option object or null when no value is selected.
|
|
119
119
|
* @see https://primereact.org/dropdown/#template
|
|
120
120
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Dropdown.d.ts","sourceRoot":"","sources":["../../../src/components/dropdown/Dropdown.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAsD,MAAM,OAAO,CAAA;AAI1E,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAA;IACjE,aAAa,EAAE,KAAK,CAAC,cAAc,CAAA;CACpC;AAED,MAAM,WAAW,oBAAoB;IACnC,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAA;IACb,wFAAwF;IACxF,aAAa,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAA;IAC7C,aAAa,EAAE,KAAK,CAAC,aAAa,CAAA;CACnC;AAED,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,cAAc;IAC/C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,mBAAmB,KAAK,IAAI,CAAA;IAC3C;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;IAC1B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC5B;;OAEG;IACH,OAAO,EAAE,CAAC,EAAE,CAAA;IACZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,GAAG,MAAM,CAAA;IAC9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,GAAG,MAAM,CAAA;IAC9B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,GAAG,MAAM,CAAA;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAC7C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,KAAK,KAAK,CAAC,SAAS,CAAA;IACrD;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,KAAK,CAAC,SAAS,CAAA;IAC7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AA4BD,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,mTA0BzD,aAAa,CAAC,CAAC,CAAC,
|
|
1
|
+
{"version":3,"file":"Dropdown.d.ts","sourceRoot":"","sources":["../../../src/components/dropdown/Dropdown.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAsD,MAAM,OAAO,CAAA;AAI1E,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAA;IACjE,aAAa,EAAE,KAAK,CAAC,cAAc,CAAA;CACpC;AAED,MAAM,WAAW,oBAAoB;IACnC,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAA;IACb,wFAAwF;IACxF,aAAa,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAA;IAC7C,aAAa,EAAE,KAAK,CAAC,aAAa,CAAA;CACnC;AAED,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,cAAc;IAC/C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,mBAAmB,KAAK,IAAI,CAAA;IAC3C;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;IAC1B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC5B;;OAEG;IACH,OAAO,EAAE,CAAC,EAAE,CAAA;IACZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,GAAG,MAAM,CAAA;IAC9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,GAAG,MAAM,CAAA;IAC9B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,GAAG,MAAM,CAAA;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAC7C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,KAAK,KAAK,CAAC,SAAS,CAAA;IACrD;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,KAAK,CAAC,SAAS,CAAA;IAC7C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AA4BD,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,mTA0BzD,aAAa,CAAC,CAAC,CAAC,4CA6dlB,CAAA"}
|