@react-ui-org/react-ui 0.60.0 → 0.62.0
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/.env.playwright +9 -0
- package/.env.playwright.dist +9 -0
- package/.eslintrc-ts +40 -0
- package/.nvmrc +1 -1
- package/README.md +18 -1
- package/dist/react-ui.css +16 -16
- package/dist/react-ui.development.css +249 -177
- package/dist/react-ui.development.js +477 -477
- package/dist/react-ui.js +1 -1
- package/jest.config-ts.js +34 -0
- package/package.json +53 -37
- package/playwright-ct.config.ts +68 -0
- package/src/components/Alert/Alert.jsx +2 -2
- package/src/components/Button/Button.jsx +5 -5
- package/src/components/Button/README.md +1 -1
- package/src/components/ButtonGroup/ButtonGroup.jsx +1 -1
- package/src/components/Card/CardFooter.jsx +1 -1
- package/src/components/CheckboxField/CheckboxField.jsx +3 -3
- package/src/components/FileInputField/FileInputField.jsx +13 -5
- package/src/components/FormLayout/FormLayout.jsx +1 -1
- package/src/components/FormLayout/FormLayoutCustomField.jsx +4 -4
- package/src/components/FormLayout/README.md +10 -10
- package/src/components/Grid/Grid.jsx +1 -1
- package/src/components/Grid/GridSpan.jsx +1 -1
- package/src/components/InputGroup/InputGroup.jsx +24 -4
- package/src/components/InputGroup/InputGroup.module.scss +2 -1
- package/src/components/InputGroup/README.md +69 -14
- package/src/components/Modal/Modal.jsx +12 -7
- package/src/components/Modal/ModalBody.jsx +1 -1
- package/src/components/Modal/ModalContent.jsx +1 -1
- package/src/components/Popover/Popover.jsx +5 -5
- package/src/components/Radio/README.md +4 -4
- package/src/components/Radio/Radio.jsx +3 -3
- package/src/components/ScrollView/ScrollView.jsx +3 -3
- package/src/components/SelectField/README.md +5 -5
- package/src/components/SelectField/SelectField.jsx +9 -6
- package/src/components/Table/Table.jsx +1 -1
- package/src/components/Table/_components/TableBodyCell/TableBodyCell.jsx +1 -1
- package/src/components/Table/_components/TableHeaderCell/TableHeaderCell.jsx +1 -1
- package/src/components/Tabs/TabsItem.jsx +3 -3
- package/src/components/Text/Text.jsx +1 -1
- package/src/components/TextArea/TextArea.jsx +3 -3
- package/src/components/TextField/TextField.jsx +11 -8
- package/src/components/Toggle/README.md +9 -9
- package/src/components/Toggle/Toggle.jsx +3 -3
- package/src/components/Toolbar/Toolbar.jsx +1 -1
- package/src/components/Toolbar/ToolbarGroup.jsx +1 -1
- package/src/components/Toolbar/ToolbarItem.jsx +1 -1
- package/src/providers/globalProps/GlobalPropsProvider.jsx +1 -1
- package/src/providers/translations/TranslationsProvider.jsx +1 -1
- package/src/styles/settings/_breakpoints.scss +2 -0
- package/tsconfig.json +27 -0
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
module.exports = {
|
|
3
|
+
extensionsToTreatAsEsm: [
|
|
4
|
+
'.ts',
|
|
5
|
+
'.tsx',
|
|
6
|
+
],
|
|
7
|
+
moduleFileExtensions: [
|
|
8
|
+
'js',
|
|
9
|
+
'jsx',
|
|
10
|
+
'ts',
|
|
11
|
+
'tsx',
|
|
12
|
+
],
|
|
13
|
+
moduleNameMapper: {
|
|
14
|
+
'\\.scss$': 'identity-obj-proxy',
|
|
15
|
+
'\\.svg$': '<rootDir>/tests/jest/mocks/svgrMock.jsx',
|
|
16
|
+
},
|
|
17
|
+
preset: 'ts-jest',
|
|
18
|
+
setupFiles: [
|
|
19
|
+
'<rootDir>/tests/jest/setupJest.js',
|
|
20
|
+
],
|
|
21
|
+
setupFilesAfterEnv: [
|
|
22
|
+
],
|
|
23
|
+
testEnvironment: '@happy-dom/jest-environment',
|
|
24
|
+
testMatch: [
|
|
25
|
+
'**/*.test.{ts,tsx}',
|
|
26
|
+
],
|
|
27
|
+
transform: {
|
|
28
|
+
'^.+\\.(ts|tsx)$': [
|
|
29
|
+
'ts-jest',
|
|
30
|
+
{ useESM: true },
|
|
31
|
+
],
|
|
32
|
+
},
|
|
33
|
+
verbose: true,
|
|
34
|
+
};
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@react-ui-org/react-ui",
|
|
3
3
|
"description": "React UI is a themeable UI library for React apps.",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.62.0",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"react",
|
|
7
7
|
"ui",
|
|
@@ -29,12 +29,12 @@
|
|
|
29
29
|
"url": "https://github.com/react-ui-org/react-ui"
|
|
30
30
|
},
|
|
31
31
|
"engines": {
|
|
32
|
-
"node": ">=
|
|
32
|
+
"node": ">=22"
|
|
33
33
|
},
|
|
34
34
|
"devEngines": {
|
|
35
35
|
"runtime": {
|
|
36
36
|
"name": "node",
|
|
37
|
-
"version": "22.x",
|
|
37
|
+
"version": "22.x || 24.x",
|
|
38
38
|
"onFail": "error"
|
|
39
39
|
},
|
|
40
40
|
"packageManager": {
|
|
@@ -47,17 +47,24 @@
|
|
|
47
47
|
"copy": "npm run copy:css && npm run copy:js",
|
|
48
48
|
"copy:css": "cp src/docs/_assets/generated/react-ui.css dist && cp src/docs/_assets/generated/react-ui.development.css dist",
|
|
49
49
|
"copy:js": "cp src/docs/_assets/generated/react-ui.js dist && cp src/docs/_assets/generated/react-ui.development.js dist",
|
|
50
|
-
"eslint": "eslint
|
|
51
|
-
"
|
|
50
|
+
"eslint": "npm run eslint:ts && npm run eslint:js",
|
|
51
|
+
"eslint:js": "eslint --ext js,jsx src",
|
|
52
|
+
"eslint:ts": "eslint --ext ts,tsx -c .eslintrc-ts src tests",
|
|
52
53
|
"lint": "npm run eslint && npm run markdownlint && npm run stylelint",
|
|
53
|
-
"markdownlint": "markdownlint-cli2 \"
|
|
54
|
+
"markdownlint": "markdownlint-cli2 \"README.md\" \"src/**/*.md\"",
|
|
54
55
|
"postbuild": "npm run copy",
|
|
55
|
-
"postinstall": "cp -n .env.dist .env || true",
|
|
56
|
+
"postinstall": "cp -n .env.dist .env && cp -n .env.playwright.dist .env.playwright || true",
|
|
56
57
|
"precopy": "rm -rf dist && mkdir dist",
|
|
57
58
|
"prepublishOnly": "npm run build",
|
|
58
59
|
"start": "webpack --watch --mode=development",
|
|
59
60
|
"stylelint": "stylelint \"src/**/*.{css,scss}\" \"!src/docs/_assets/generated/**\" --config stylelint.config.js",
|
|
60
|
-
"test": "npm run jest"
|
|
61
|
+
"test": "npm run test:jest",
|
|
62
|
+
"test:jest": "npm run test:jest:ts && npm run test:jest:js",
|
|
63
|
+
"test:jest:js": "jest --coverage",
|
|
64
|
+
"test:jest:ts": "jest -c jest.config-ts.js --coverage",
|
|
65
|
+
"test:playwright-ct:all": "playwright test -c playwright-ct.config.ts",
|
|
66
|
+
"test:playwright-ct:all-with-update": "playwright test -c playwright-ct.config.ts --update-snapshots",
|
|
67
|
+
"test:playwright-ct:show-report": "playwright show-report --host=0.0.0.0 --port=9323"
|
|
61
68
|
},
|
|
62
69
|
"dependencies": {
|
|
63
70
|
"normalize.css": "^8.0.1"
|
|
@@ -68,53 +75,62 @@
|
|
|
68
75
|
"react-dom": "~18.2.0"
|
|
69
76
|
},
|
|
70
77
|
"devDependencies": {
|
|
71
|
-
"@babel/cli": "^7.
|
|
72
|
-
"@babel/core": "^7.
|
|
73
|
-
"@babel/eslint-parser": "^7.
|
|
78
|
+
"@babel/cli": "^7.28.3",
|
|
79
|
+
"@babel/core": "^7.28.5",
|
|
80
|
+
"@babel/eslint-parser": "^7.28.5",
|
|
74
81
|
"@babel/plugin-proposal-class-properties": "^7.18.6",
|
|
75
|
-
"@babel/plugin-transform-spread": "^7.
|
|
76
|
-
"@babel/preset-env": "^7.
|
|
77
|
-
"@babel/preset-react": "^7.
|
|
78
|
-
"@babel/register": "^7.
|
|
79
|
-
"@happy-dom/jest-environment": "^
|
|
82
|
+
"@babel/plugin-transform-spread": "^7.27.1",
|
|
83
|
+
"@babel/preset-env": "^7.28.5",
|
|
84
|
+
"@babel/preset-react": "^7.28.5",
|
|
85
|
+
"@babel/register": "^7.28.3",
|
|
86
|
+
"@happy-dom/jest-environment": "^20.0.11",
|
|
87
|
+
"@playwright/experimental-ct-react": "^1.57.0",
|
|
80
88
|
"@stylistic/stylelint-config": "^1.0.1",
|
|
81
89
|
"@svgr/webpack": "^8.1.0",
|
|
82
|
-
"@testing-library/jest-dom": "^6.
|
|
83
|
-
"@testing-library/react": "^16.
|
|
84
|
-
"@testing-library/user-event": "^14.
|
|
90
|
+
"@testing-library/jest-dom": "^6.9.1",
|
|
91
|
+
"@testing-library/react": "^16.3.0",
|
|
92
|
+
"@testing-library/user-event": "^14.6.1",
|
|
93
|
+
"@types/jest": "^30.0.0",
|
|
94
|
+
"@types/node": "^22.19.1",
|
|
95
|
+
"@types/react": "^19.2.7",
|
|
96
|
+
"@types/react-dom": "^19.2.3",
|
|
97
|
+
"@typescript-eslint/eslint-plugin": "^7.18.0",
|
|
98
|
+
"@typescript-eslint/parser": "^7.18.0",
|
|
85
99
|
"@visionappscz/eslint-config-visionapps": "^1.7.0",
|
|
86
100
|
"@visionappscz/stylelint-config": "^4.0.0",
|
|
87
|
-
"autoprefixer": "^10.4.
|
|
88
|
-
"babel-jest": "^
|
|
89
|
-
"babel-loader": "^
|
|
90
|
-
"core-js": "^3.
|
|
101
|
+
"autoprefixer": "^10.4.22",
|
|
102
|
+
"babel-jest": "^30.2.0",
|
|
103
|
+
"babel-loader": "^10.0.0",
|
|
104
|
+
"core-js": "^3.47.0",
|
|
91
105
|
"css-loader": "^7.1.2",
|
|
106
|
+
"dotenv": "^17.2.3",
|
|
92
107
|
"eslint": "^8.57.0",
|
|
93
108
|
"eslint-config-airbnb": "^19.0.4",
|
|
109
|
+
"eslint-config-airbnb-typescript": "^18.0.0",
|
|
110
|
+
"eslint-plugin-deprecation": "^3.0.0",
|
|
94
111
|
"eslint-plugin-import": "^2.29.1",
|
|
95
112
|
"eslint-plugin-jsx-a11y": "^6.9.0",
|
|
96
113
|
"eslint-plugin-markdown": "^3.0.1",
|
|
97
114
|
"eslint-plugin-react": "^7.34.3",
|
|
98
115
|
"eslint-plugin-react-hooks": "^4.6.2",
|
|
116
|
+
"eslint-plugin-typescript-sort-keys": "^3.3.0",
|
|
99
117
|
"identity-obj-proxy": "^3.0.0",
|
|
100
|
-
"jest": "^
|
|
101
|
-
"markdownlint-cli2": "^0.
|
|
102
|
-
"mini-css-extract-plugin": "^2.9.
|
|
103
|
-
"postcss": "^8.
|
|
104
|
-
"postcss-loader": "^8.
|
|
118
|
+
"jest": "^30.2.0",
|
|
119
|
+
"markdownlint-cli2": "^0.19.1",
|
|
120
|
+
"mini-css-extract-plugin": "^2.9.4",
|
|
121
|
+
"postcss": "^8.5.6",
|
|
122
|
+
"postcss-loader": "^8.2.0",
|
|
105
123
|
"prop-types": "^15.8.1",
|
|
106
124
|
"react": "~18.2.0",
|
|
107
125
|
"react-dom": "~18.2.0",
|
|
108
|
-
"sass": "^1.
|
|
109
|
-
"sass-loader": "^
|
|
126
|
+
"sass": "^1.94.2",
|
|
127
|
+
"sass-loader": "^16.0.6",
|
|
110
128
|
"stylelint": "^16.7.0",
|
|
111
129
|
"stylelint-webpack-plugin": "^5.0.1",
|
|
112
|
-
"terser-webpack-plugin": "^5.3.
|
|
113
|
-
"
|
|
114
|
-
"webpack
|
|
115
|
-
"webpack-
|
|
116
|
-
|
|
117
|
-
"resolutions": {
|
|
118
|
-
"@babel/plugin-transform-spread": "7.24.7"
|
|
130
|
+
"terser-webpack-plugin": "^5.3.15",
|
|
131
|
+
"ts-jest": "^29.4.6",
|
|
132
|
+
"webpack": "^5.103.0",
|
|
133
|
+
"webpack-cli": "^6.0.1",
|
|
134
|
+
"webpack-visualizer-plugin2": "^2.0.0"
|
|
119
135
|
}
|
|
120
136
|
}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import {
|
|
2
|
+
defineConfig,
|
|
3
|
+
devices,
|
|
4
|
+
} from '@playwright/experimental-ct-react';
|
|
5
|
+
import { parseEnvironment } from './tests/playwright/env/parseEnvironment';
|
|
6
|
+
|
|
7
|
+
const environment = parseEnvironment();
|
|
8
|
+
|
|
9
|
+
const isCI = !!process.env.CI;
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* @see https://playwright.dev/docs/test-configuration
|
|
13
|
+
*/
|
|
14
|
+
module.exports = defineConfig({
|
|
15
|
+
// Fail the build on CI if you accidentally left test.only in the source code
|
|
16
|
+
forbidOnly: isCI,
|
|
17
|
+
// Run tests in files in parallel
|
|
18
|
+
fullyParallel: true,
|
|
19
|
+
// Directory where the output generated by Playwright is stored
|
|
20
|
+
outputDir: './tests/playwright/.temp/playwright-ct-output/',
|
|
21
|
+
// Run tests for following projects
|
|
22
|
+
projects: [
|
|
23
|
+
{
|
|
24
|
+
name: 'chromium',
|
|
25
|
+
use: { ...devices['Desktop Chrome'] },
|
|
26
|
+
},
|
|
27
|
+
],
|
|
28
|
+
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
|
|
29
|
+
reporter: 'html',
|
|
30
|
+
// Retry failed tests once to eliminate flakiness
|
|
31
|
+
retries: 1,
|
|
32
|
+
// Directory where the snapshots are located
|
|
33
|
+
// (must be same as testDir to save snapshots in place where tests are located)
|
|
34
|
+
snapshotDir: './src/',
|
|
35
|
+
// Directory where the tests are located
|
|
36
|
+
testDir: './src/',
|
|
37
|
+
// Pattern to search for test files
|
|
38
|
+
testMatch: '*/*.spec.{ts,tsx}',
|
|
39
|
+
// Timeout for each test
|
|
40
|
+
timeout: 10 * 1000,
|
|
41
|
+
// Do not update snapshots automatically
|
|
42
|
+
updateSnapshots: 'none',
|
|
43
|
+
// Configuration for Playwright component testing
|
|
44
|
+
use: {
|
|
45
|
+
// Directory where the cache is stored
|
|
46
|
+
ctCacheDir: './tests/playwright/.temp/playwright-ct-cache',
|
|
47
|
+
// Port to use for Playwright component endpoint
|
|
48
|
+
ctPort: environment.CT_PORT,
|
|
49
|
+
// Directory where the templates are stored
|
|
50
|
+
ctTemplateDir: './tests/playwright/templates',
|
|
51
|
+
// Launch options for Playwright
|
|
52
|
+
launchOptions: {
|
|
53
|
+
args: [
|
|
54
|
+
'--use-gl=egl',
|
|
55
|
+
// # Must be set to `new` to enable new version of Chromium Headless to obtain correct snapshots
|
|
56
|
+
'--headless=new',
|
|
57
|
+
],
|
|
58
|
+
ignoreDefaultArgs: [
|
|
59
|
+
// # Must be ignored to enable new version of Chromium Headless to obtain correct snapshots
|
|
60
|
+
'--headless',
|
|
61
|
+
],
|
|
62
|
+
},
|
|
63
|
+
// Collect trace on all retries
|
|
64
|
+
trace: 'on-all-retries',
|
|
65
|
+
},
|
|
66
|
+
// Number of workers to use
|
|
67
|
+
workers: environment.WORKERS,
|
|
68
|
+
});
|
|
@@ -101,18 +101,18 @@ export const Button = React.forwardRef((props, ref) => {
|
|
|
101
101
|
});
|
|
102
102
|
|
|
103
103
|
Button.defaultProps = {
|
|
104
|
-
afterLabel:
|
|
105
|
-
beforeLabel:
|
|
104
|
+
afterLabel: undefined,
|
|
105
|
+
beforeLabel: undefined,
|
|
106
106
|
block: false,
|
|
107
107
|
color: 'primary',
|
|
108
108
|
disabled: false,
|
|
109
|
-
endCorner:
|
|
110
|
-
feedbackIcon:
|
|
109
|
+
endCorner: undefined,
|
|
110
|
+
feedbackIcon: undefined,
|
|
111
111
|
id: undefined,
|
|
112
112
|
labelVisibility: 'xs',
|
|
113
113
|
priority: 'filled',
|
|
114
114
|
size: 'medium',
|
|
115
|
-
startCorner:
|
|
115
|
+
startCorner: undefined,
|
|
116
116
|
type: 'button',
|
|
117
117
|
};
|
|
118
118
|
|
|
@@ -28,7 +28,7 @@ See [API](#api) for all available options.
|
|
|
28
28
|
- **Don't overwhelm your UI** with too many high-emphasis actions. There should
|
|
29
29
|
always be one but chances are that having more of them is not necessary.
|
|
30
30
|
|
|
31
|
-
- Ensure the **button action is well
|
|
31
|
+
- Ensure the **button action is well recognizable** across your target audience.
|
|
32
32
|
This is especially important when using the button [with an icon only](#icon-buttons).
|
|
33
33
|
|
|
34
34
|
## Priorities
|
|
@@ -79,14 +79,14 @@ export const CheckboxField = React.forwardRef((props, ref) => {
|
|
|
79
79
|
|
|
80
80
|
CheckboxField.defaultProps = {
|
|
81
81
|
disabled: false,
|
|
82
|
-
helpText:
|
|
82
|
+
helpText: undefined,
|
|
83
83
|
id: undefined,
|
|
84
84
|
isLabelVisible: true,
|
|
85
85
|
labelPosition: 'after',
|
|
86
86
|
renderAsRequired: false,
|
|
87
87
|
required: false,
|
|
88
|
-
validationState:
|
|
89
|
-
validationText:
|
|
88
|
+
validationState: undefined,
|
|
89
|
+
validationText: undefined,
|
|
90
90
|
};
|
|
91
91
|
|
|
92
92
|
CheckboxField.propTypes = {
|
|
@@ -78,6 +78,7 @@ export const FileInputField = React.forwardRef((props, ref) => {
|
|
|
78
78
|
const handleFileChange = (files, event) => {
|
|
79
79
|
if (files.length === 0) {
|
|
80
80
|
setSelectedFileNames([]);
|
|
81
|
+
onFilesChanged([], event);
|
|
81
82
|
return;
|
|
82
83
|
}
|
|
83
84
|
|
|
@@ -85,6 +86,7 @@ export const FileInputField = React.forwardRef((props, ref) => {
|
|
|
85
86
|
// does not accept multiple files, no files are processed.
|
|
86
87
|
if (files.length > 1 && !multiple) {
|
|
87
88
|
setSelectedFileNames([]);
|
|
89
|
+
onFilesChanged([], event);
|
|
88
90
|
return;
|
|
89
91
|
}
|
|
90
92
|
|
|
@@ -221,7 +223,7 @@ export const FileInputField = React.forwardRef((props, ref) => {
|
|
|
221
223
|
</Text>
|
|
222
224
|
</button>
|
|
223
225
|
</div>
|
|
224
|
-
{helpText && (
|
|
226
|
+
{(helpText && !inputGroupContext) && (
|
|
225
227
|
<div
|
|
226
228
|
className={styles.helpText}
|
|
227
229
|
id={`${id}__helpText`}
|
|
@@ -229,7 +231,7 @@ export const FileInputField = React.forwardRef((props, ref) => {
|
|
|
229
231
|
{helpText}
|
|
230
232
|
</div>
|
|
231
233
|
)}
|
|
232
|
-
{validationText && (
|
|
234
|
+
{(validationText && !inputGroupContext) && (
|
|
233
235
|
<div
|
|
234
236
|
className={styles.validationText}
|
|
235
237
|
id={`${id}__validationText`}
|
|
@@ -245,14 +247,14 @@ export const FileInputField = React.forwardRef((props, ref) => {
|
|
|
245
247
|
FileInputField.defaultProps = {
|
|
246
248
|
disabled: false,
|
|
247
249
|
fullWidth: false,
|
|
248
|
-
helpText:
|
|
250
|
+
helpText: undefined,
|
|
249
251
|
isLabelVisible: true,
|
|
250
252
|
layout: 'vertical',
|
|
251
253
|
multiple: false,
|
|
252
254
|
required: false,
|
|
253
255
|
size: 'medium',
|
|
254
|
-
validationState:
|
|
255
|
-
validationText:
|
|
256
|
+
validationState: undefined,
|
|
257
|
+
validationText: undefined,
|
|
256
258
|
};
|
|
257
259
|
|
|
258
260
|
FileInputField.propTypes = {
|
|
@@ -266,6 +268,9 @@ FileInputField.propTypes = {
|
|
|
266
268
|
fullWidth: PropTypes.bool,
|
|
267
269
|
/**
|
|
268
270
|
* Optional help text.
|
|
271
|
+
*
|
|
272
|
+
* Help text is never rendered when the component is placed into `InputGroup`.
|
|
273
|
+
* If a help text is needed, it must be defined on the `InputGroup` component instead.
|
|
269
274
|
*/
|
|
270
275
|
helpText: PropTypes.node,
|
|
271
276
|
/**
|
|
@@ -319,6 +324,9 @@ FileInputField.propTypes = {
|
|
|
319
324
|
validationState: PropTypes.oneOf(['invalid', 'valid', 'warning']),
|
|
320
325
|
/**
|
|
321
326
|
* Validation message to be displayed.
|
|
327
|
+
*
|
|
328
|
+
* Validation text is never rendered when the component is placed into `InputGroup`.
|
|
329
|
+
* If a validation text is needed, it must be defined on the `InputGroup` component instead.
|
|
322
330
|
*/
|
|
323
331
|
validationText: PropTypes.node,
|
|
324
332
|
};
|
|
@@ -80,15 +80,15 @@ export const FormLayoutCustomField = ({
|
|
|
80
80
|
};
|
|
81
81
|
|
|
82
82
|
FormLayoutCustomField.defaultProps = {
|
|
83
|
-
children:
|
|
83
|
+
children: undefined,
|
|
84
84
|
disabled: false,
|
|
85
85
|
fullWidth: false,
|
|
86
86
|
id: undefined,
|
|
87
|
-
innerFieldSize:
|
|
88
|
-
label:
|
|
87
|
+
innerFieldSize: undefined,
|
|
88
|
+
label: undefined,
|
|
89
89
|
labelForId: undefined,
|
|
90
90
|
required: false,
|
|
91
|
-
validationState:
|
|
91
|
+
validationState: undefined,
|
|
92
92
|
};
|
|
93
93
|
|
|
94
94
|
FormLayoutCustomField.propTypes = {
|
|
@@ -441,22 +441,22 @@ A place for custom content inside FormLayout.
|
|
|
441
441
|
|
|
442
442
|
## Theming
|
|
443
443
|
|
|
444
|
-
| Custom Property
|
|
445
|
-
|
|
446
|
-
| `--rui-FormLayout__row-gap`
|
|
447
|
-
| `--rui-FormLayout--horizontal__label__width`
|
|
448
|
-
| `--rui-FormLayout--horizontal__label__width--auto`
|
|
449
|
-
| `--rui-FormLayout--horizontal__label__width--limited`
|
|
444
|
+
| Custom Property | Description |
|
|
445
|
+
|--------------------------------------------------------|-------------------------------------|
|
|
446
|
+
| `--rui-FormLayout__row-gap` | Gap between individual rows |
|
|
447
|
+
| `--rui-FormLayout--horizontal__label__width` | Default label width |
|
|
448
|
+
| `--rui-FormLayout--horizontal__label__width--auto` | Label width in automatic layout |
|
|
449
|
+
| `--rui-FormLayout--horizontal__label__width--limited` | Label width in limited-width layout |
|
|
450
450
|
|
|
451
451
|
### FormLayoutCustomField Theming
|
|
452
452
|
|
|
453
453
|
FormLayoutCustomField can be styled using a small subset of
|
|
454
454
|
[other form fields theming options](/docs/customize/theming/forms).
|
|
455
455
|
|
|
456
|
-
| Custom Property
|
|
457
|
-
|
|
458
|
-
| `--rui-FormField--custom--default__surrounding-text-color`
|
|
459
|
-
| `--rui-FormField--custom--disabled__surrounding-text-color` | Custom field label color in disabled-like state
|
|
456
|
+
| Custom Property | Description |
|
|
457
|
+
|-------------------------------------------------------------|--------------------------------------------------|
|
|
458
|
+
| `--rui-FormField--custom--default__surrounding-text-color` | Custom field label color in default state |
|
|
459
|
+
| `--rui-FormField--custom--disabled__surrounding-text-color` | Custom field label color in disabled-like state |
|
|
460
460
|
|
|
461
461
|
[div-attributes]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div#attributes
|
|
462
462
|
[fragments]: https://reactjs.org/docs/fragments.html
|
|
@@ -18,6 +18,7 @@ import styles from './InputGroup.module.scss';
|
|
|
18
18
|
export const InputGroup = ({
|
|
19
19
|
children,
|
|
20
20
|
disabled,
|
|
21
|
+
helpTexts,
|
|
21
22
|
id,
|
|
22
23
|
isLabelVisible,
|
|
23
24
|
label,
|
|
@@ -89,7 +90,21 @@ export const InputGroup = ({
|
|
|
89
90
|
{children}
|
|
90
91
|
</InputGroupContext.Provider>
|
|
91
92
|
</div>
|
|
92
|
-
{
|
|
93
|
+
{helpTexts && helpTexts.length > 0 && (
|
|
94
|
+
<ul
|
|
95
|
+
className={styles.helpText}
|
|
96
|
+
id={id && `${id}__helpTexts`}
|
|
97
|
+
>
|
|
98
|
+
{helpTexts.map((helpText) => (
|
|
99
|
+
<li key={helpText}>
|
|
100
|
+
<Text blockLevel>
|
|
101
|
+
{helpText}
|
|
102
|
+
</Text>
|
|
103
|
+
</li>
|
|
104
|
+
))}
|
|
105
|
+
</ul>
|
|
106
|
+
)}
|
|
107
|
+
{validationTexts && validationTexts.length > 0 && (
|
|
93
108
|
<ul
|
|
94
109
|
className={styles.validationText}
|
|
95
110
|
id={id && `${id}__validationTexts`}
|
|
@@ -109,14 +124,15 @@ export const InputGroup = ({
|
|
|
109
124
|
};
|
|
110
125
|
|
|
111
126
|
InputGroup.defaultProps = {
|
|
112
|
-
children:
|
|
127
|
+
children: undefined,
|
|
113
128
|
disabled: false,
|
|
129
|
+
helpTexts: undefined,
|
|
114
130
|
id: undefined,
|
|
115
131
|
isLabelVisible: true,
|
|
116
132
|
layout: 'vertical',
|
|
117
133
|
required: false,
|
|
118
134
|
size: 'medium',
|
|
119
|
-
validationTexts:
|
|
135
|
+
validationTexts: undefined,
|
|
120
136
|
};
|
|
121
137
|
|
|
122
138
|
InputGroup.propTypes = {
|
|
@@ -133,6 +149,10 @@ InputGroup.propTypes = {
|
|
|
133
149
|
* If `true`, the whole input group with all nested inputs and buttons will be disabled.
|
|
134
150
|
*/
|
|
135
151
|
disabled: PropTypes.bool,
|
|
152
|
+
/**
|
|
153
|
+
* An array of help texts to be displayed.
|
|
154
|
+
*/
|
|
155
|
+
helpTexts: PropTypes.arrayOf(PropTypes.node),
|
|
136
156
|
/**
|
|
137
157
|
* ID of the root HTML element.
|
|
138
158
|
*
|
|
@@ -171,7 +191,7 @@ InputGroup.propTypes = {
|
|
|
171
191
|
/**
|
|
172
192
|
* An array of validation messages to be displayed.
|
|
173
193
|
*/
|
|
174
|
-
validationTexts: PropTypes.node,
|
|
194
|
+
validationTexts: PropTypes.arrayOf(PropTypes.node),
|
|
175
195
|
};
|
|
176
196
|
|
|
177
197
|
export const InputGroupWithGlobalProps = withGlobalProps(InputGroup, 'InputGroup');
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// 1. The class
|
|
1
|
+
// 1. The class names are intentionally singular because they are also targeted by other mixins.
|
|
2
2
|
// 2. Use a block-level display mode to prevent extra white space below grouped inputs in Safari.
|
|
3
3
|
// 3. Let wide input groups honor the minimum input width and overflow horizontally without wrapping and distorting
|
|
4
4
|
// the inputs.
|
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
}
|
|
40
40
|
|
|
41
41
|
// 1.
|
|
42
|
+
.helpText,
|
|
42
43
|
.validationText {
|
|
43
44
|
@include reset.list();
|
|
44
45
|
@include foundation.help-text();
|