diff --git a/package-lock.json b/package-lock.json
index d78cc1120..24480844b 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -63,7 +63,7 @@
"eslint-plugin-jest": "^27.2.1",
"eslint-plugin-jest-dom": "^4.0.3",
"eslint-plugin-testing-library": "^5.11.0",
- "glob": "^8.1.0",
+ "glob": "^10.3.1",
"html-webpack-plugin": "^5.5.3",
"husky": "^8.0.3",
"jest": "^29.5.0",
@@ -11411,8 +11411,9 @@
},
"node_modules/eslint-config-adslot/plugin": {
"name": "eslint-plugin-adslot",
- "version": "0.0.1",
- "dev": true
+ "version": "1.0.0",
+ "dev": true,
+ "license": "ISC"
},
"node_modules/eslint-config-prettier": {
"version": "8.8.0",
@@ -13110,19 +13111,22 @@
}
},
"node_modules/glob": {
- "version": "8.1.0",
- "resolved": "https://registry.npmjs.org/glob/-/glob-8.1.0.tgz",
- "integrity": "sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==",
+ "version": "10.3.3",
+ "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.3.tgz",
+ "integrity": "sha512-92vPiMb/iqpmEgsOoIDvTjc50wf9CCCvMzsi6W0JLPeUKE8TWP1a73PgqSrqy7iAZxaSD1YdzU7QZR5LF51MJw==",
"dev": true,
"dependencies": {
- "fs.realpath": "^1.0.0",
- "inflight": "^1.0.4",
- "inherits": "2",
- "minimatch": "^5.0.1",
- "once": "^1.3.0"
+ "foreground-child": "^3.1.0",
+ "jackspeak": "^2.0.3",
+ "minimatch": "^9.0.1",
+ "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0",
+ "path-scurry": "^1.10.1"
+ },
+ "bin": {
+ "glob": "dist/cjs/src/bin.js"
},
"engines": {
- "node": ">=12"
+ "node": ">=16 || 14 >=14.17"
},
"funding": {
"url": "https://github.com/sponsors/isaacs"
@@ -13155,16 +13159,47 @@
"balanced-match": "^1.0.0"
}
},
+ "node_modules/glob/node_modules/foreground-child": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz",
+ "integrity": "sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg==",
+ "dev": true,
+ "dependencies": {
+ "cross-spawn": "^7.0.0",
+ "signal-exit": "^4.0.1"
+ },
+ "engines": {
+ "node": ">=14"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
"node_modules/glob/node_modules/minimatch": {
- "version": "5.1.6",
- "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz",
- "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==",
+ "version": "9.0.3",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz",
+ "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==",
"dev": true,
"dependencies": {
"brace-expansion": "^2.0.1"
},
"engines": {
- "node": ">=10"
+ "node": ">=16 || 14 >=14.17"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/glob/node_modules/signal-exit": {
+ "version": "4.0.2",
+ "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.0.2.tgz",
+ "integrity": "sha512-MY2/qGx4enyjprQnFaZsHib3Yadh3IXyV2C321GY0pjGfVBu4un0uDJkwgdxqO+Rdx8JMT8IfJIRwbYVz3Ob3Q==",
+ "dev": true,
+ "engines": {
+ "node": ">=14"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
}
},
"node_modules/global-dirs": {
@@ -19571,13 +19606,13 @@
"integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw=="
},
"node_modules/path-scurry": {
- "version": "1.10.0",
- "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.10.0.tgz",
- "integrity": "sha512-tZFEaRQbMLjwrsmidsGJ6wDMv0iazJWk6SfIKnY4Xru8auXgmJkOBa5DUbYFcFD2Rzk2+KDlIiF0GVXNCbgC7g==",
+ "version": "1.10.1",
+ "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.10.1.tgz",
+ "integrity": "sha512-MkhCqzzBEpPvxxQ71Md0b1Kk51W01lrYvlMzSUaIzNsODdd7mqhiimSZlr+VegAz5Z6Vzt9Xg2ttE//XBhH3EQ==",
"dev": true,
"dependencies": {
"lru-cache": "^9.1.1 || ^10.0.0",
- "minipass": "^5.0.0 || ^6.0.2"
+ "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0"
},
"engines": {
"node": ">=16 || 14 >=14.17"
@@ -22676,80 +22711,6 @@
"url": "https://github.com/sponsors/isaacs"
}
},
- "node_modules/rimraf/node_modules/brace-expansion": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz",
- "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==",
- "dev": true,
- "dependencies": {
- "balanced-match": "^1.0.0"
- }
- },
- "node_modules/rimraf/node_modules/foreground-child": {
- "version": "3.1.1",
- "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz",
- "integrity": "sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg==",
- "dev": true,
- "dependencies": {
- "cross-spawn": "^7.0.0",
- "signal-exit": "^4.0.1"
- },
- "engines": {
- "node": ">=14"
- },
- "funding": {
- "url": "https://github.com/sponsors/isaacs"
- }
- },
- "node_modules/rimraf/node_modules/glob": {
- "version": "10.3.1",
- "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.1.tgz",
- "integrity": "sha512-9BKYcEeIs7QwlCYs+Y3GBvqAMISufUS0i2ELd11zpZjxI5V9iyRj0HgzB5/cLf2NY4vcYBTYzJ7GIui7j/4DOw==",
- "dev": true,
- "dependencies": {
- "foreground-child": "^3.1.0",
- "jackspeak": "^2.0.3",
- "minimatch": "^9.0.1",
- "minipass": "^5.0.0 || ^6.0.2",
- "path-scurry": "^1.10.0"
- },
- "bin": {
- "glob": "dist/cjs/src/bin.js"
- },
- "engines": {
- "node": ">=16 || 14 >=14.17"
- },
- "funding": {
- "url": "https://github.com/sponsors/isaacs"
- }
- },
- "node_modules/rimraf/node_modules/minimatch": {
- "version": "9.0.3",
- "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz",
- "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==",
- "dev": true,
- "dependencies": {
- "brace-expansion": "^2.0.1"
- },
- "engines": {
- "node": ">=16 || 14 >=14.17"
- },
- "funding": {
- "url": "https://github.com/sponsors/isaacs"
- }
- },
- "node_modules/rimraf/node_modules/signal-exit": {
- "version": "4.0.2",
- "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.0.2.tgz",
- "integrity": "sha512-MY2/qGx4enyjprQnFaZsHib3Yadh3IXyV2C321GY0pjGfVBu4un0uDJkwgdxqO+Rdx8JMT8IfJIRwbYVz3Ob3Q==",
- "dev": true,
- "engines": {
- "node": ">=14"
- },
- "funding": {
- "url": "https://github.com/sponsors/isaacs"
- }
- },
"node_modules/run-parallel": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
@@ -35948,16 +35909,16 @@
}
},
"glob": {
- "version": "8.1.0",
- "resolved": "https://registry.npmjs.org/glob/-/glob-8.1.0.tgz",
- "integrity": "sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==",
+ "version": "10.3.3",
+ "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.3.tgz",
+ "integrity": "sha512-92vPiMb/iqpmEgsOoIDvTjc50wf9CCCvMzsi6W0JLPeUKE8TWP1a73PgqSrqy7iAZxaSD1YdzU7QZR5LF51MJw==",
"dev": true,
"requires": {
- "fs.realpath": "^1.0.0",
- "inflight": "^1.0.4",
- "inherits": "2",
- "minimatch": "^5.0.1",
- "once": "^1.3.0"
+ "foreground-child": "^3.1.0",
+ "jackspeak": "^2.0.3",
+ "minimatch": "^9.0.1",
+ "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0",
+ "path-scurry": "^1.10.1"
},
"dependencies": {
"brace-expansion": {
@@ -35969,14 +35930,30 @@
"balanced-match": "^1.0.0"
}
},
+ "foreground-child": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz",
+ "integrity": "sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg==",
+ "dev": true,
+ "requires": {
+ "cross-spawn": "^7.0.0",
+ "signal-exit": "^4.0.1"
+ }
+ },
"minimatch": {
- "version": "5.1.6",
- "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz",
- "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==",
+ "version": "9.0.3",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz",
+ "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==",
"dev": true,
"requires": {
"brace-expansion": "^2.0.1"
}
+ },
+ "signal-exit": {
+ "version": "4.0.2",
+ "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.0.2.tgz",
+ "integrity": "sha512-MY2/qGx4enyjprQnFaZsHib3Yadh3IXyV2C321GY0pjGfVBu4un0uDJkwgdxqO+Rdx8JMT8IfJIRwbYVz3Ob3Q==",
+ "dev": true
}
}
},
@@ -40732,13 +40709,13 @@
"integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw=="
},
"path-scurry": {
- "version": "1.10.0",
- "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.10.0.tgz",
- "integrity": "sha512-tZFEaRQbMLjwrsmidsGJ6wDMv0iazJWk6SfIKnY4Xru8auXgmJkOBa5DUbYFcFD2Rzk2+KDlIiF0GVXNCbgC7g==",
+ "version": "1.10.1",
+ "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.10.1.tgz",
+ "integrity": "sha512-MkhCqzzBEpPvxxQ71Md0b1Kk51W01lrYvlMzSUaIzNsODdd7mqhiimSZlr+VegAz5Z6Vzt9Xg2ttE//XBhH3EQ==",
"dev": true,
"requires": {
"lru-cache": "^9.1.1 || ^10.0.0",
- "minipass": "^5.0.0 || ^6.0.2"
+ "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0"
},
"dependencies": {
"lru-cache": {
@@ -42769,55 +42746,6 @@
"dev": true,
"requires": {
"glob": "^10.2.5"
- },
- "dependencies": {
- "brace-expansion": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz",
- "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==",
- "dev": true,
- "requires": {
- "balanced-match": "^1.0.0"
- }
- },
- "foreground-child": {
- "version": "3.1.1",
- "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz",
- "integrity": "sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg==",
- "dev": true,
- "requires": {
- "cross-spawn": "^7.0.0",
- "signal-exit": "^4.0.1"
- }
- },
- "glob": {
- "version": "10.3.1",
- "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.1.tgz",
- "integrity": "sha512-9BKYcEeIs7QwlCYs+Y3GBvqAMISufUS0i2ELd11zpZjxI5V9iyRj0HgzB5/cLf2NY4vcYBTYzJ7GIui7j/4DOw==",
- "dev": true,
- "requires": {
- "foreground-child": "^3.1.0",
- "jackspeak": "^2.0.3",
- "minimatch": "^9.0.1",
- "minipass": "^5.0.0 || ^6.0.2",
- "path-scurry": "^1.10.0"
- }
- },
- "minimatch": {
- "version": "9.0.3",
- "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz",
- "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==",
- "dev": true,
- "requires": {
- "brace-expansion": "^2.0.1"
- }
- },
- "signal-exit": {
- "version": "4.0.2",
- "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.0.2.tgz",
- "integrity": "sha512-MY2/qGx4enyjprQnFaZsHib3Yadh3IXyV2C321GY0pjGfVBu4un0uDJkwgdxqO+Rdx8JMT8IfJIRwbYVz3Ob3Q==",
- "dev": true
- }
}
},
"run-parallel": {
diff --git a/package.json b/package.json
index 4586ec631..b424b7d35 100644
--- a/package.json
+++ b/package.json
@@ -115,7 +115,7 @@
"eslint-plugin-jest": "^27.2.1",
"eslint-plugin-jest-dom": "^4.0.3",
"eslint-plugin-testing-library": "^5.11.0",
- "glob": "^8.1.0",
+ "glob": "^10.3.1",
"html-webpack-plugin": "^5.5.3",
"husky": "^8.0.3",
"jest": "^29.5.0",
diff --git a/scripts/generateDocs.js b/scripts/generateDocs.js
index e7dda2e92..a5400c383 100644
--- a/scripts/generateDocs.js
+++ b/scripts/generateDocs.js
@@ -1,10 +1,9 @@
const _ = require('lodash');
const fs = require('fs');
const path = require('path');
-const { promisify } = require('util');
const reactDocgen = require('react-docgen');
const displayNameHandler = require('react-docgen-displayname-handler').default;
-const glob = require('glob');
+const { glob } = require('glob');
const handlers = reactDocgen.defaultHandlers.concat(displayNameHandler);
@@ -13,7 +12,7 @@ const filesToIgnore = ['mocks.jsx', 'spec.jsx', 'test.jsx', 'BlockStyleButtons',
const outputFilePath = path.join(__dirname, '../www/containers/props.json');
(async () => {
- const files = _.reject(await promisify(glob)('src/components/**/*.jsx', { cwd: sourcePath }), (filePath) =>
+ const files = _.reject((await glob('src/components/**/*.jsx', { cwd: sourcePath })).sort(), (filePath) =>
_.some(filesToIgnore, (ignoreFile) => _.includes(filePath, ignoreFile))
);
diff --git a/www/containers/props.json b/www/containers/props.json
index ba9d3b55e..baf364865 100644
--- a/www/containers/props.json
+++ b/www/containers/props.json
@@ -560,6 +560,46 @@
}
}
],
+ "src/components/Breadcrumb/Node/index.jsx": [
+ {
+ "description": "",
+ "displayName": "BreadcrumbNode",
+ "methods": [],
+ "props": {
+ "isLast": {
+ "type": {
+ "name": "bool"
+ },
+ "required": true,
+ "description": ""
+ },
+ "node": {
+ "type": {
+ "name": "shape",
+ "value": {
+ "id": {
+ "name": "string",
+ "required": true
+ },
+ "label": {
+ "name": "string",
+ "required": true
+ }
+ }
+ },
+ "required": false,
+ "description": ""
+ },
+ "onClick": {
+ "type": {
+ "name": "func"
+ },
+ "required": true,
+ "description": ""
+ }
+ }
+ }
+ ],
"src/components/Breadcrumb/index.jsx": [
{
"description": "",
@@ -666,46 +706,6 @@
}
}
],
- "src/components/Breadcrumb/Node/index.jsx": [
- {
- "description": "",
- "displayName": "BreadcrumbNode",
- "methods": [],
- "props": {
- "isLast": {
- "type": {
- "name": "bool"
- },
- "required": true,
- "description": ""
- },
- "node": {
- "type": {
- "name": "shape",
- "value": {
- "id": {
- "name": "string",
- "required": true
- },
- "label": {
- "name": "string",
- "required": true
- }
- }
- },
- "required": false,
- "description": ""
- },
- "onClick": {
- "type": {
- "name": "func"
- },
- "required": true,
- "description": ""
- }
- }
- }
- ],
"src/components/Button/index.jsx": [
{
"description": "",
@@ -2019,29 +2019,6 @@
}
}
],
- "src/components/Grid/index.jsx": [
- {
- "description": "",
- "displayName": "Grid",
- "methods": [],
- "props": {
- "children": {
- "type": {
- "name": "node"
- },
- "required": false,
- "description": "the children to be rendered"
- },
- "dts": {
- "type": {
- "name": "string"
- },
- "required": false,
- "description": "data-test-selector of the grid"
- }
- }
- }
- ],
"src/components/Grid/Row/index.jsx": [
{
"description": "",
@@ -2127,6 +2104,29 @@
}
}
],
+ "src/components/Grid/index.jsx": [
+ {
+ "description": "",
+ "displayName": "Grid",
+ "methods": [],
+ "props": {
+ "children": {
+ "type": {
+ "name": "node"
+ },
+ "required": false,
+ "description": "the children to be rendered"
+ },
+ "dts": {
+ "type": {
+ "name": "string"
+ },
+ "required": false,
+ "description": "data-test-selector of the grid"
+ }
+ }
+ }
+ ],
"src/components/HelpIconPopover/index.jsx": [
{
"description": "",
@@ -2908,6 +2908,40 @@
}
}
],
+ "src/components/PageTitle/index.jsx": [
+ {
+ "description": "",
+ "displayName": "PageTitle",
+ "methods": [],
+ "props": {
+ "children": {
+ "type": {
+ "name": "node"
+ },
+ "required": false,
+ "description": ""
+ },
+ "isFooter": {
+ "type": {
+ "name": "bool"
+ },
+ "required": false,
+ "description": "",
+ "defaultValue": {
+ "value": "false",
+ "computed": false
+ }
+ },
+ "title": {
+ "type": {
+ "name": "node"
+ },
+ "required": false,
+ "description": ""
+ }
+ }
+ }
+ ],
"src/components/PagedGrid/index.jsx": [
{
"description": "",
@@ -2967,40 +3001,6 @@
}
}
],
- "src/components/PageTitle/index.jsx": [
- {
- "description": "",
- "displayName": "PageTitle",
- "methods": [],
- "props": {
- "children": {
- "type": {
- "name": "node"
- },
- "required": false,
- "description": ""
- },
- "isFooter": {
- "type": {
- "name": "bool"
- },
- "required": false,
- "description": "",
- "defaultValue": {
- "value": "false",
- "computed": false
- }
- },
- "title": {
- "type": {
- "name": "node"
- },
- "required": false,
- "description": ""
- }
- }
- }
- ],
"src/components/Pagination/index.jsx": [
{
"description": "",
@@ -3389,56 +3389,22 @@
}
}
],
- "src/components/Popover/index.jsx": [
+ "src/components/Popover/Popper.jsx": [
{
"description": "",
- "displayName": "Popover",
+ "displayName": "Popper",
"methods": [],
"props": {
- "theme": {
- "type": {
- "name": "enum",
- "computed": true,
- "value": "themes"
- },
- "required": false,
- "description": "",
- "defaultValue": {
- "value": "'light'",
- "computed": false
- }
- },
- "title": {
- "type": {
- "name": "node"
- },
- "required": false,
- "description": ""
- },
- "className": {
- "type": {
- "name": "string"
- },
- "required": false,
- "description": ""
- },
- "popoverClassNames": {
- "type": {
- "name": "string"
- },
- "required": false,
- "description": ""
- },
"arrowStyles": {
"type": {
"name": "object"
},
"required": false,
- "description": "arrow css styles, mainly for positioning the arrow"
+ "description": ""
},
- "wrapperStyles": {
+ "dts": {
"type": {
- "name": "object"
+ "name": "string"
},
"required": false,
"description": ""
@@ -3459,7 +3425,11 @@
]
},
"required": false,
- "description": ""
+ "description": "",
+ "defaultValue": {
+ "value": "[]",
+ "computed": false
+ }
},
"placement": {
"type": {
@@ -3468,11 +3438,7 @@
"value": "popoverPlacements"
},
"required": false,
- "description": "",
- "defaultValue": {
- "value": "'auto'",
- "computed": false
- }
+ "description": ""
},
"strategy": {
"type": {
@@ -3481,11 +3447,14 @@
"value": "popoverStrategies"
},
"required": false,
- "description": "",
- "defaultValue": {
- "value": "'absolute'",
- "computed": false
- }
+ "description": ""
+ },
+ "popoverClass": {
+ "type": {
+ "name": "string"
+ },
+ "required": false,
+ "description": ""
},
"popoverContent": {
"type": {
@@ -3502,51 +3471,32 @@
"required": true,
"description": ""
},
- "children": {
+ "refElement": {
"type": {
- "name": "node"
+ "name": "instanceOf",
+ "value": "Element"
},
- "required": true,
+ "required": false,
"description": ""
},
- "triggers": {
+ "boundariesElement": {
"type": {
- "name": "union",
- "value": [
- {
- "name": "custom",
- "raw": "triggerPropTypes"
- },
- {
- "name": "arrayOf",
- "value": {
- "name": "custom",
- "raw": "triggerPropTypes"
- }
- }
- ]
+ "name": "instanceOf",
+ "value": "Element"
},
"required": false,
- "description": "",
- "defaultValue": {
- "value": "'hover'",
- "computed": false
- }
+ "description": ""
},
- "isOpen": {
+ "title": {
"type": {
- "name": "bool"
+ "name": "string"
},
"required": false,
- "description": "",
- "defaultValue": {
- "value": "false",
- "computed": false
- }
+ "description": ""
},
- "getContainer": {
+ "wrapperStyles": {
"type": {
- "name": "func"
+ "name": "object"
},
"required": false,
"description": ""
@@ -3557,37 +3507,64 @@
},
"required": false,
"description": ""
- },
- "dts": {
- "type": {
- "name": "string"
- },
- "required": false,
- "description": ""
}
}
}
],
- "src/components/Popover/Popper.jsx": [
+ "src/components/Popover/index.jsx": [
{
"description": "",
- "displayName": "Popper",
+ "displayName": "Popover",
"methods": [],
"props": {
- "arrowStyles": {
+ "theme": {
"type": {
- "name": "object"
+ "name": "enum",
+ "computed": true,
+ "value": "themes"
+ },
+ "required": false,
+ "description": "",
+ "defaultValue": {
+ "value": "'light'",
+ "computed": false
+ }
+ },
+ "title": {
+ "type": {
+ "name": "node"
},
"required": false,
"description": ""
},
- "dts": {
+ "className": {
+ "type": {
+ "name": "string"
+ },
+ "required": false,
+ "description": ""
+ },
+ "popoverClassNames": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
+ "arrowStyles": {
+ "type": {
+ "name": "object"
+ },
+ "required": false,
+ "description": "arrow css styles, mainly for positioning the arrow"
+ },
+ "wrapperStyles": {
+ "type": {
+ "name": "object"
+ },
+ "required": false,
+ "description": ""
+ },
"modifiers": {
"type": {
"name": "union",
@@ -3604,11 +3581,7 @@
]
},
"required": false,
- "description": "",
- "defaultValue": {
- "value": "[]",
- "computed": false
- }
+ "description": ""
},
"placement": {
"type": {
@@ -3617,7 +3590,11 @@
"value": "popoverPlacements"
},
"required": false,
- "description": ""
+ "description": "",
+ "defaultValue": {
+ "value": "'auto'",
+ "computed": false
+ }
},
"strategy": {
"type": {
@@ -3626,14 +3603,11 @@
"value": "popoverStrategies"
},
"required": false,
- "description": ""
- },
- "popoverClass": {
- "type": {
- "name": "string"
- },
- "required": false,
- "description": ""
+ "description": "",
+ "defaultValue": {
+ "value": "'absolute'",
+ "computed": false
+ }
},
"popoverContent": {
"type": {
@@ -3650,32 +3624,51 @@
"required": true,
"description": ""
},
- "refElement": {
+ "children": {
"type": {
- "name": "instanceOf",
- "value": "Element"
+ "name": "node"
},
- "required": false,
+ "required": true,
"description": ""
},
- "boundariesElement": {
+ "triggers": {
"type": {
- "name": "instanceOf",
- "value": "Element"
+ "name": "union",
+ "value": [
+ {
+ "name": "custom",
+ "raw": "triggerPropTypes"
+ },
+ {
+ "name": "arrayOf",
+ "value": {
+ "name": "custom",
+ "raw": "triggerPropTypes"
+ }
+ }
+ ]
},
"required": false,
- "description": ""
+ "description": "",
+ "defaultValue": {
+ "value": "'hover'",
+ "computed": false
+ }
},
- "title": {
+ "isOpen": {
"type": {
- "name": "string"
+ "name": "bool"
},
"required": false,
- "description": ""
+ "description": "",
+ "defaultValue": {
+ "value": "false",
+ "computed": false
+ }
},
- "wrapperStyles": {
+ "getContainer": {
"type": {
- "name": "object"
+ "name": "func"
},
"required": false,
"description": ""
@@ -3686,6 +3679,13 @@
},
"required": false,
"description": ""
+ },
+ "dts": {
+ "type": {
+ "name": "string"
+ },
+ "required": false,
+ "description": ""
}
}
}
@@ -4033,44 +4033,155 @@
}
}
],
- "src/components/RichTextEditor/index.jsx": [
+ "src/components/RichTextEditor/MentionAction.jsx": [
{
"description": "",
- "displayName": "RichTextEditor",
- "methods": [
- {
- "name": "stateToHTML",
- "docblock": null,
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "name": "input",
- "optional": false,
- "type": null
- }
- ],
- "returns": null
+ "displayName": "MentionAction",
+ "methods": [],
+ "props": {
+ "onToggle": {
+ "type": {
+ "name": "func"
+ },
+ "required": false,
+ "description": ""
+ }
+ }
+ }
+ ],
+ "src/components/RichTextEditor/MentionEntry.jsx": [
+ {
+ "description": "",
+ "displayName": "MentionEntry",
+ "methods": [],
+ "props": {
+ "className": {
+ "type": {
+ "name": "string"
+ },
+ "required": false,
+ "description": ""
},
- {
- "name": "stateFromHTML",
- "docblock": "@example\n// parser exaple with dom-purify\nconst DOMPurifyDefaultConfig = {\n USE_PROFILES: { html: true },\n FORBID_TAGS: ['style'],\n FORBID_ATTR: ['style'],\n};\nconst parser = (html) => DOMPurify.sanitize(html, { ...DOMPurifyConfig, RETURN_DOM: true });\n\nRichTextEditor.stateFromHTML(html, { parser });",
- "modifiers": [
- "static"
- ],
- "params": [
- {
- "name": "input",
- "optional": false
- },
- {
- "name": "options"
+ "mention": {
+ "type": {
+ "name": "shape",
+ "value": {
+ "name": {
+ "name": "string",
+ "required": false
+ },
+ "title": {
+ "name": "string",
+ "required": false
+ },
+ "avatar": {
+ "name": "string",
+ "required": false
+ }
}
- ],
- "returns": null,
- "description": null
- },
+ },
+ "required": false,
+ "description": ""
+ },
+ "onMouseDown": {
+ "type": {
+ "name": "func"
+ },
+ "required": false,
+ "description": ""
+ },
+ "onMouseUp": {
+ "type": {
+ "name": "func"
+ },
+ "required": false,
+ "description": ""
+ },
+ "onMouseEnter": {
+ "type": {
+ "name": "func"
+ },
+ "required": false,
+ "description": ""
+ },
+ "isFocused": {
+ "type": {
+ "name": "bool"
+ },
+ "required": false,
+ "description": ""
+ }
+ }
+ }
+ ],
+ "src/components/RichTextEditor/ToolbarButton.jsx": [
+ {
+ "description": "",
+ "displayName": "ToolbarButton",
+ "methods": [],
+ "props": {
+ "onToggle": {
+ "type": {
+ "name": "func"
+ },
+ "required": true,
+ "description": ""
+ },
+ "label": {
+ "type": {
+ "name": "node"
+ },
+ "required": true,
+ "description": ""
+ },
+ "active": {
+ "type": {
+ "name": "bool"
+ },
+ "required": false,
+ "description": ""
+ }
+ }
+ }
+ ],
+ "src/components/RichTextEditor/index.jsx": [
+ {
+ "description": "",
+ "displayName": "RichTextEditor",
+ "methods": [
+ {
+ "name": "stateToHTML",
+ "docblock": null,
+ "modifiers": [
+ "static"
+ ],
+ "params": [
+ {
+ "name": "input",
+ "optional": false,
+ "type": null
+ }
+ ],
+ "returns": null
+ },
+ {
+ "name": "stateFromHTML",
+ "docblock": "@example\n// parser exaple with dom-purify\nconst DOMPurifyDefaultConfig = {\n USE_PROFILES: { html: true },\n FORBID_TAGS: ['style'],\n FORBID_ATTR: ['style'],\n};\nconst parser = (html) => DOMPurify.sanitize(html, { ...DOMPurifyConfig, RETURN_DOM: true });\n\nRichTextEditor.stateFromHTML(html, { parser });",
+ "modifiers": [
+ "static"
+ ],
+ "params": [
+ {
+ "name": "input",
+ "optional": false
+ },
+ {
+ "name": "options"
+ }
+ ],
+ "returns": null,
+ "description": null
+ },
{
"name": "stateToPlainText",
"docblock": null,
@@ -4223,117 +4334,6 @@
}
}
],
- "src/components/RichTextEditor/MentionAction.jsx": [
- {
- "description": "",
- "displayName": "MentionAction",
- "methods": [],
- "props": {
- "onToggle": {
- "type": {
- "name": "func"
- },
- "required": false,
- "description": ""
- }
- }
- }
- ],
- "src/components/RichTextEditor/MentionEntry.jsx": [
- {
- "description": "",
- "displayName": "MentionEntry",
- "methods": [],
- "props": {
- "className": {
- "type": {
- "name": "string"
- },
- "required": false,
- "description": ""
- },
- "mention": {
- "type": {
- "name": "shape",
- "value": {
- "name": {
- "name": "string",
- "required": false
- },
- "title": {
- "name": "string",
- "required": false
- },
- "avatar": {
- "name": "string",
- "required": false
- }
- }
- },
- "required": false,
- "description": ""
- },
- "onMouseDown": {
- "type": {
- "name": "func"
- },
- "required": false,
- "description": ""
- },
- "onMouseUp": {
- "type": {
- "name": "func"
- },
- "required": false,
- "description": ""
- },
- "onMouseEnter": {
- "type": {
- "name": "func"
- },
- "required": false,
- "description": ""
- },
- "isFocused": {
- "type": {
- "name": "bool"
- },
- "required": false,
- "description": ""
- }
- }
- }
- ],
- "src/components/RichTextEditor/ToolbarButton.jsx": [
- {
- "description": "",
- "displayName": "ToolbarButton",
- "methods": [],
- "props": {
- "onToggle": {
- "type": {
- "name": "func"
- },
- "required": true,
- "description": ""
- },
- "label": {
- "type": {
- "name": "node"
- },
- "required": true,
- "description": ""
- },
- "active": {
- "type": {
- "name": "bool"
- },
- "required": false,
- "description": ""
- }
- }
- }
- ],
"src/components/Search/index.jsx": [
{
"description": "",
@@ -4788,6 +4788,26 @@
"methods": []
}
],
+ "src/components/Slicey/Marker/index.jsx": [
+ {
+ "description": "",
+ "displayName": "Marker",
+ "methods": [],
+ "props": {
+ "fraction": {
+ "type": {
+ "name": "number"
+ },
+ "required": false,
+ "description": "",
+ "defaultValue": {
+ "value": "0",
+ "computed": false
+ }
+ }
+ }
+ }
+ ],
"src/components/Slicey/index.jsx": [
{
"description": "",
@@ -4847,26 +4867,6 @@
}
}
],
- "src/components/Slicey/Marker/index.jsx": [
- {
- "description": "",
- "displayName": "Marker",
- "methods": [],
- "props": {
- "fraction": {
- "type": {
- "name": "number"
- },
- "required": false,
- "description": "",
- "defaultValue": {
- "value": "0",
- "computed": false
- }
- }
- }
- }
- ],
"src/components/Spinner/index.jsx": [
{
"description": "",
@@ -5440,7 +5440,36 @@
}
}
],
- "src/components/Textarea/index.jsx": [
+ "src/components/TextEllipsis/index.jsx": [
+ {
+ "description": "",
+ "displayName": "TextEllipsis",
+ "methods": [],
+ "props": {
+ "children": {
+ "type": {
+ "name": "node"
+ },
+ "required": true,
+ "description": ""
+ },
+ "popoverProps": {
+ "type": {
+ "name": "shape",
+ "value": "_.pick(Popover.propTypes, ['placement', 'trigger'])",
+ "computed": true
+ },
+ "required": false,
+ "description": "",
+ "defaultValue": {
+ "value": "{\n placement: 'top',\n trigger: 'hover',\n}",
+ "computed": false
+ }
+ }
+ }
+ }
+ ],
+ "src/components/Textarea/index.jsx": [
{
"description": "",
"displayName": "Textarea",
@@ -5494,35 +5523,6 @@
}
}
],
- "src/components/TextEllipsis/index.jsx": [
- {
- "description": "",
- "displayName": "TextEllipsis",
- "methods": [],
- "props": {
- "children": {
- "type": {
- "name": "node"
- },
- "required": true,
- "description": ""
- },
- "popoverProps": {
- "type": {
- "name": "shape",
- "value": "_.pick(Popover.propTypes, ['placement', 'trigger'])",
- "computed": true
- },
- "required": false,
- "description": "",
- "defaultValue": {
- "value": "{\n placement: 'top',\n trigger: 'hover',\n}",
- "computed": false
- }
- }
- }
- }
- ],
"src/components/Tile/index.jsx": [
{
"description": "",
@@ -5984,158 +5984,49 @@
}
}
],
- "src/components/TreePicker/index.jsx": [
+ "src/components/TreePicker/Nav/index.jsx": [
{
"description": "",
- "displayName": "TreePickerSimplePure",
+ "displayName": "TreePickerNav",
"methods": [],
"props": {
- "additionalClassNames": {
- "type": {
- "name": "arrayOf",
- "value": {
- "name": "string"
- }
- },
- "required": false,
- "description": "Class Names for SplitPane component"
- },
"breadcrumbRootNode": {
"type": {
"name": "custom",
"raw": "TreePickerPropTypesBreadCrumbNode"
},
"required": false,
- "description": "Optional. This prop allows customization of the Breadcrumb root node. { id: PropTypes.sting | PropTypes.number, label: PropTypes.string}"
+ "description": ""
},
"breadcrumbNodes": {
"type": {
"name": "arrayOf",
"value": {
"name": "custom",
- "raw": "TreePickerPropTypesBreadCrumbNode.isRequired"
+ "raw": "TreePickerPropTypesBreadCrumbNode"
}
},
"required": false,
- "description": "Returns node id. This prop is not required, but an empty array is not allowed. At least one element is required in the array."
+ "description": ""
},
"breadcrumbOnClick": {
"type": {
"name": "func"
},
"required": false,
- "description": "This propType creates a list of breadcrumb node"
- },
- "debounceInterval": {
- "type": {
- "name": "number"
- },
- "required": false,
- "description": "Interval time on search",
- "defaultValue": {
- "value": "0",
- "computed": false
- }
+ "description": ""
},
"disabled": {
"type": {
"name": "bool"
},
"required": false,
- "description": "Disables treepicker including search bar",
+ "description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
- "disableInclude": {
- "type": {
- "name": "bool"
- },
- "required": false,
- "description": "Disables treepicker's grid item"
- },
- "emptySvgSymbol": {
- "type": {
- "name": "node"
- },
- "required": false,
- "description": "The svg symbol used when there will be no item on both left or right Grid"
- },
- "emptySelectedListSvgSymbol": {
- "type": {
- "name": "node"
- },
- "required": false,
- "description": "The svg symbol used when there will be no item on right Grid (Selected list)"
- },
- "emptyText": {
- "type": {
- "name": "node"
- },
- "required": false,
- "description": "Displays this text when there will be no item on left Grid. Prefer type 'string', but rich text can be used here"
- },
- "emptySelectedListText": {
- "type": {
- "name": "node"
- },
- "required": false,
- "description": "Displays this text when there will be no item on right Grid(Selected list). Prefer type 'string', but rich text can be used here."
- },
- "expandNode": {
- "type": {
- "name": "func"
- },
- "required": false,
- "description": "Triggers when clicking any item in the left Grid"
- },
- "groupFormatter": {
- "type": {
- "name": "func"
- },
- "required": false,
- "description": "This function use to transform keys of the list item in the left Grid"
- },
- "hideIcon": {
- "type": {
- "name": "bool"
- },
- "required": false,
- "description": "Hides the empty icon on right Grid (Selected list). Given emptySvgSymbol and hideIcon together, the empty symbol will be only displayed on the left grid."
- },
- "includeNode": {
- "type": {
- "name": "func"
- },
- "required": false,
- "description": "Click event on '+' button of each list Item"
- },
- "initialStateNode": {
- "type": {
- "name": "node"
- },
- "required": false,
- "description": "Same as emptyText"
- },
- "initialStateSymbol": {
- "type": {
- "name": "node"
- },
- "required": false,
- "description": "Same as emptySymbol"
- },
- "itemType": {
- "type": {
- "name": "string"
- },
- "required": false,
- "description": "Uses for specific className",
- "defaultValue": {
- "value": "'node'",
- "computed": false
- }
- },
"isLoading": {
"type": {
"name": "bool"
@@ -6147,47 +6038,48 @@
"computed": false
}
},
- "nodeRenderer": {
- "type": {
- "name": "func"
- },
- "required": false,
- "description": "Uses for rendering custom node"
- },
- "removeNode": {
+ "onChange": {
"type": {
"name": "func"
},
"required": false,
"description": ""
},
- "onChange": {
+ "onClear": {
"type": {
"name": "func"
},
"required": false,
- "description": "Triggers when search input changes"
+ "description": ""
},
- "onClear": {
+ "onSearch": {
"type": {
"name": "func"
},
"required": false,
- "description": "Triggers when the user clicks the clear button on search input"
+ "description": "",
+ "defaultValue": {
+ "value": "_.noop",
+ "computed": true
+ }
},
- "onSearch": {
+ "debounceInterval": {
"type": {
- "name": "func"
+ "name": "number"
},
"required": false,
- "description": "Please see Search"
+ "description": "",
+ "defaultValue": {
+ "value": "0",
+ "computed": false
+ }
},
"searchOnEnter": {
"type": {
"name": "bool"
},
"required": false,
- "description": "Please see Search",
+ "description": "",
"defaultValue": {
"value": "false",
"computed": false
@@ -6200,7 +6092,7 @@
"required": false,
"description": "",
"defaultValue": {
- "value": "'Search'",
+ "value": "''",
"computed": false
}
},
@@ -6211,39 +6103,17 @@
"required": false,
"description": ""
},
- "selectedNodes": {
- "type": {
- "name": "arrayOf",
- "value": {
- "name": "custom",
- "raw": "TreePickerPropTypesNode"
- }
- },
- "required": true,
- "description": ""
- },
"showSearch": {
"type": {
"name": "bool"
},
"required": false,
- "description": "Show or hide the search field on the selection pane",
+ "description": "",
"defaultValue": {
"value": "true",
"computed": false
}
},
- "subtree": {
- "type": {
- "name": "arrayOf",
- "value": {
- "name": "custom",
- "raw": "TreePickerPropTypesNode.isRequired"
- }
- },
- "required": false,
- "description": "A list of available unselected nodes. This prop is not required, but an empty array is not allowed. At least one element is required in the array."
- },
"svgSymbolCancel": {
"type": {
"name": "node"
@@ -6257,19 +6127,66 @@
},
"required": false,
"description": ""
- },
- "displayGroupHeader": {
+ }
+ }
+ }
+ ],
+ "src/components/TreePicker/Node/Expander/index.jsx": [
+ {
+ "description": "",
+ "displayName": "TreePickerNodeExpander",
+ "methods": [],
+ "props": {
+ "isLoading": {
"type": {
"name": "bool"
},
"required": false,
- "description": "e.g: Default Group",
+ "description": "",
"defaultValue": {
- "value": "true",
+ "value": "false",
"computed": false
}
},
- "hideSearchOnRoot": {
+ "onClick": {
+ "type": {
+ "name": "func"
+ },
+ "required": true,
+ "description": ""
+ }
+ }
+ }
+ ],
+ "src/components/TreePicker/Node/index.jsx": [
+ {
+ "description": "",
+ "displayName": "TreePickerNode",
+ "methods": [
+ {
+ "name": "setLoadingAndExpandNode",
+ "docblock": null,
+ "modifiers": [],
+ "params": [],
+ "returns": null
+ },
+ {
+ "name": "handleRemove",
+ "docblock": null,
+ "modifiers": [],
+ "params": [],
+ "returns": null
+ },
+ {
+ "name": "handleInclude",
+ "docblock": null,
+ "modifiers": [],
+ "params": [],
+ "returns": null
+ }
+ ],
+ "props": {
+ "disabled": {
"type": {
"name": "bool"
},
@@ -6280,12 +6197,82 @@
"computed": false
}
},
- "selectedTopSearch": {
+ "expandNode": {
"type": {
- "name": "node"
+ "name": "func"
},
"required": false,
- "description": "A react node to be rendered at the top of the right hand side pane. Generally we are expecting a search component."
+ "description": ""
+ },
+ "includeNode": {
+ "type": {
+ "name": "func"
+ },
+ "required": false,
+ "description": "",
+ "defaultValue": {
+ "value": "(node) => {\n console.error(`AdslotUi TreePickerNode needs an includeNode handler for ${node.id}`);\n}",
+ "computed": false
+ }
+ },
+ "itemType": {
+ "type": {
+ "name": "string"
+ },
+ "required": true,
+ "description": ""
+ },
+ "node": {
+ "type": {
+ "name": "custom",
+ "raw": "TreePickerPropTypesNode.isRequired"
+ },
+ "required": false,
+ "description": ""
+ },
+ "nodeRenderer": {
+ "type": {
+ "name": "func"
+ },
+ "required": false,
+ "description": "",
+ "defaultValue": {
+ "value": "(node) => node.label",
+ "computed": false
+ }
+ },
+ "removeNode": {
+ "type": {
+ "name": "func"
+ },
+ "required": false,
+ "description": "",
+ "defaultValue": {
+ "value": "(node) => {\n console.error(`AdslotUi TreePickerNode needs a removeNode handler for ${node.id}`);\n}",
+ "computed": false
+ }
+ },
+ "selected": {
+ "type": {
+ "name": "bool"
+ },
+ "required": false,
+ "description": "",
+ "defaultValue": {
+ "value": "false",
+ "computed": false
+ }
+ },
+ "valueFormatter": {
+ "type": {
+ "name": "func"
+ },
+ "required": false,
+ "description": "",
+ "defaultValue": {
+ "value": "(value) => value",
+ "computed": false
+ }
},
"addNodePopoverInfoProps": {
"type": {
@@ -6304,97 +6291,159 @@
}
}
],
- "src/components/TreePicker/Nav/index.jsx": [
+ "src/components/TreePicker/index.jsx": [
{
"description": "",
- "displayName": "TreePickerNav",
+ "displayName": "TreePickerSimplePure",
"methods": [],
"props": {
+ "additionalClassNames": {
+ "type": {
+ "name": "arrayOf",
+ "value": {
+ "name": "string"
+ }
+ },
+ "required": false,
+ "description": "Class Names for SplitPane component"
+ },
"breadcrumbRootNode": {
"type": {
"name": "custom",
"raw": "TreePickerPropTypesBreadCrumbNode"
},
"required": false,
- "description": ""
+ "description": "Optional. This prop allows customization of the Breadcrumb root node. { id: PropTypes.sting | PropTypes.number, label: PropTypes.string}"
},
"breadcrumbNodes": {
"type": {
"name": "arrayOf",
"value": {
"name": "custom",
- "raw": "TreePickerPropTypesBreadCrumbNode"
+ "raw": "TreePickerPropTypesBreadCrumbNode.isRequired"
}
},
"required": false,
- "description": ""
+ "description": "Returns node id. This prop is not required, but an empty array is not allowed. At least one element is required in the array."
},
"breadcrumbOnClick": {
"type": {
"name": "func"
},
"required": false,
- "description": ""
+ "description": "This propType creates a list of breadcrumb node"
},
- "disabled": {
+ "debounceInterval": {
"type": {
- "name": "bool"
+ "name": "number"
},
"required": false,
- "description": "",
+ "description": "Interval time on search",
"defaultValue": {
- "value": "false",
+ "value": "0",
"computed": false
}
},
- "isLoading": {
+ "disabled": {
"type": {
"name": "bool"
},
"required": false,
- "description": "",
+ "description": "Disables treepicker including search bar",
"defaultValue": {
"value": "false",
"computed": false
}
},
- "onChange": {
+ "disableInclude": {
+ "type": {
+ "name": "bool"
+ },
+ "required": false,
+ "description": "Disables treepicker's grid item"
+ },
+ "emptySvgSymbol": {
+ "type": {
+ "name": "node"
+ },
+ "required": false,
+ "description": "The svg symbol used when there will be no item on both left or right Grid"
+ },
+ "emptySelectedListSvgSymbol": {
+ "type": {
+ "name": "node"
+ },
+ "required": false,
+ "description": "The svg symbol used when there will be no item on right Grid (Selected list)"
+ },
+ "emptyText": {
+ "type": {
+ "name": "node"
+ },
+ "required": false,
+ "description": "Displays this text when there will be no item on left Grid. Prefer type 'string', but rich text can be used here"
+ },
+ "emptySelectedListText": {
+ "type": {
+ "name": "node"
+ },
+ "required": false,
+ "description": "Displays this text when there will be no item on right Grid(Selected list). Prefer type 'string', but rich text can be used here."
+ },
+ "expandNode": {
"type": {
"name": "func"
},
"required": false,
- "description": ""
+ "description": "Triggers when clicking any item in the left Grid"
},
- "onClear": {
+ "groupFormatter": {
"type": {
"name": "func"
},
"required": false,
- "description": ""
+ "description": "This function use to transform keys of the list item in the left Grid"
},
- "onSearch": {
+ "hideIcon": {
+ "type": {
+ "name": "bool"
+ },
+ "required": false,
+ "description": "Hides the empty icon on right Grid (Selected list). Given emptySvgSymbol and hideIcon together, the empty symbol will be only displayed on the left grid."
+ },
+ "includeNode": {
"type": {
"name": "func"
},
"required": false,
- "description": "",
- "defaultValue": {
- "value": "_.noop",
- "computed": true
- }
+ "description": "Click event on '+' button of each list Item"
},
- "debounceInterval": {
+ "initialStateNode": {
"type": {
- "name": "number"
+ "name": "node"
},
"required": false,
- "description": "",
+ "description": "Same as emptyText"
+ },
+ "initialStateSymbol": {
+ "type": {
+ "name": "node"
+ },
+ "required": false,
+ "description": "Same as emptySymbol"
+ },
+ "itemType": {
+ "type": {
+ "name": "string"
+ },
+ "required": false,
+ "description": "Uses for specific className",
"defaultValue": {
- "value": "0",
+ "value": "'node'",
"computed": false
}
},
- "searchOnEnter": {
+ "isLoading": {
"type": {
"name": "bool"
},
@@ -6405,174 +6454,129 @@
"computed": false
}
},
- "searchPlaceholder": {
+ "nodeRenderer": {
"type": {
- "name": "string"
+ "name": "func"
},
"required": false,
- "description": "",
- "defaultValue": {
- "value": "''",
- "computed": false
- }
+ "description": "Uses for rendering custom node"
},
- "searchValue": {
+ "removeNode": {
"type": {
- "name": "string"
+ "name": "func"
},
"required": false,
"description": ""
},
- "showSearch": {
+ "onChange": {
"type": {
- "name": "bool"
+ "name": "func"
},
"required": false,
- "description": "",
- "defaultValue": {
- "value": "true",
- "computed": false
- }
+ "description": "Triggers when search input changes"
},
- "svgSymbolCancel": {
+ "onClear": {
"type": {
- "name": "node"
+ "name": "func"
},
"required": false,
- "description": ""
+ "description": "Triggers when the user clicks the clear button on search input"
},
- "svgSymbolSearch": {
+ "onSearch": {
"type": {
- "name": "node"
+ "name": "func"
},
"required": false,
- "description": ""
- }
- }
- }
- ],
- "src/components/TreePicker/Node/Expander/index.jsx": [
- {
- "description": "",
- "displayName": "TreePickerNodeExpander",
- "methods": [],
- "props": {
- "isLoading": {
+ "description": "Please see Search"
+ },
+ "searchOnEnter": {
"type": {
"name": "bool"
},
"required": false,
- "description": "",
+ "description": "Please see Search",
"defaultValue": {
"value": "false",
"computed": false
}
},
- "onClick": {
- "type": {
- "name": "func"
- },
- "required": true,
- "description": ""
- }
- }
- }
- ],
- "src/components/TreePicker/Node/index.jsx": [
- {
- "description": "",
- "displayName": "TreePickerNode",
- "methods": [
- {
- "name": "setLoadingAndExpandNode",
- "docblock": null,
- "modifiers": [],
- "params": [],
- "returns": null
- },
- {
- "name": "handleRemove",
- "docblock": null,
- "modifiers": [],
- "params": [],
- "returns": null
- },
- {
- "name": "handleInclude",
- "docblock": null,
- "modifiers": [],
- "params": [],
- "returns": null
- }
- ],
- "props": {
- "disabled": {
+ "searchPlaceholder": {
"type": {
- "name": "bool"
+ "name": "string"
},
"required": false,
"description": "",
"defaultValue": {
- "value": "false",
+ "value": "'Search'",
"computed": false
}
},
- "expandNode": {
+ "searchValue": {
"type": {
- "name": "func"
+ "name": "string"
},
"required": false,
"description": ""
},
- "includeNode": {
+ "selectedNodes": {
"type": {
- "name": "func"
+ "name": "arrayOf",
+ "value": {
+ "name": "custom",
+ "raw": "TreePickerPropTypesNode"
+ }
+ },
+ "required": true,
+ "description": ""
+ },
+ "showSearch": {
+ "type": {
+ "name": "bool"
},
"required": false,
- "description": "",
+ "description": "Show or hide the search field on the selection pane",
"defaultValue": {
- "value": "(node) => {\n console.error(`AdslotUi TreePickerNode needs an includeNode handler for ${node.id}`);\n}",
+ "value": "true",
"computed": false
}
},
- "itemType": {
+ "subtree": {
"type": {
- "name": "string"
+ "name": "arrayOf",
+ "value": {
+ "name": "custom",
+ "raw": "TreePickerPropTypesNode.isRequired"
+ }
},
- "required": true,
- "description": ""
+ "required": false,
+ "description": "A list of available unselected nodes. This prop is not required, but an empty array is not allowed. At least one element is required in the array."
},
- "node": {
+ "svgSymbolCancel": {
"type": {
- "name": "custom",
- "raw": "TreePickerPropTypesNode.isRequired"
+ "name": "node"
},
"required": false,
"description": ""
},
- "nodeRenderer": {
+ "svgSymbolSearch": {
"type": {
- "name": "func"
+ "name": "node"
},
"required": false,
- "description": "",
- "defaultValue": {
- "value": "(node) => node.label",
- "computed": false
- }
+ "description": ""
},
- "removeNode": {
+ "displayGroupHeader": {
"type": {
- "name": "func"
+ "name": "bool"
},
"required": false,
- "description": "",
+ "description": "e.g: Default Group",
"defaultValue": {
- "value": "(node) => {\n console.error(`AdslotUi TreePickerNode needs a removeNode handler for ${node.id}`);\n}",
+ "value": "true",
"computed": false
}
},
- "selected": {
+ "hideSearchOnRoot": {
"type": {
"name": "bool"
},
@@ -6583,16 +6587,12 @@
"computed": false
}
},
- "valueFormatter": {
+ "selectedTopSearch": {
"type": {
- "name": "func"
+ "name": "node"
},
"required": false,
- "description": "",
- "defaultValue": {
- "value": "(value) => value",
- "computed": false
- }
+ "description": "A react node to be rendered at the top of the right hand side pane. Generally we are expecting a search component."
},
"addNodePopoverInfoProps": {
"type": {