diff --git a/.github/workflows/chromatic.yml b/.github/workflows/chromatic.yml index be9bbea35c9..33baff6a777 100644 --- a/.github/workflows/chromatic.yml +++ b/.github/workflows/chromatic.yml @@ -17,8 +17,10 @@ jobs: - uses: actions/setup-node@v4 with: node-version-file: package.json - - run: npm install - - run: npm --workspace="packages/calcite-design-tokens" run build + - run: | + npm install + npm --workspace="packages/calcite-design-tokens" run build + npm --workspace="packages/calcite-ui-icons" run build - name: Publish to Chromatic uses: chromaui/action@v11 with: diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 5ab1bb067f8..813bb6a8e06 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,8 +1,8 @@ { - "packages/calcite-components": "2.10.1", - "packages/calcite-components-react": "2.10.1", + "packages/calcite-components": "2.11.0", + "packages/calcite-components-react": "2.11.0", "packages/calcite-design-tokens": "2.2.0", - "packages/calcite-ui-icons": "3.29.0", + "packages/calcite-ui-icons": "3.30.0", "packages/eslint-plugin-calcite-components": "1.2.0", - "packages/calcite-components-angular/projects/component-library": "2.10.1" + "packages/calcite-components-angular/projects/component-library": "2.11.0" } diff --git a/package-lock.json b/package-lock.json index c646116fae0..5f03f9f7f4f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -65,14 +65,14 @@ "chromatic": "11.5.6", "concurrently": "8.2.2", "conventional-changelog-conventionalcommits": "7.0.2", - "cpy": "11.0.1", + "cpy": "11.1.0", "cpy-cli": "5.0.0", "dedent": "1.5.3", "eslint": "8.57.0", "eslint-config-prettier": "9.1.0", "eslint-plugin-import": "2.29.1", "eslint-plugin-jest": "28.6.0", - "eslint-plugin-jsdoc": "48.4.0", + "eslint-plugin-jsdoc": "48.8.3", "eslint-plugin-prettier": "5.1.3", "eslint-plugin-react": "7.34.4", "eslint-plugin-unicorn": "54.0.0", @@ -109,9 +109,9 @@ "workbox-build": "7.1.1" }, "optionalDependencies": { - "@nx/nx-darwin-arm64": "19.5.1", + "@nx/nx-darwin-arm64": "19.5.3", "@nx/nx-linux-x64-gnu": "18.3.5", - "@nx/nx-win32-x64-msvc": "19.5.1" + "@nx/nx-win32-x64-msvc": "19.5.3" } }, "node_modules/@actions/core": { @@ -3121,15 +3121,13 @@ "license": "0BSD" }, "node_modules/@es-joy/jsdoccomment": { - "version": "0.43.1", + "version": "0.46.0", + "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.46.0.tgz", + "integrity": "sha512-C3Axuq1xd/9VqFZpW4YAzOx5O9q/LP46uIQy/iNDpHG3fmPa6TBtvfglMCs3RBiBxAIi0Go97r8+jvTt55XMyQ==", "dev": true, - "license": "MIT", "dependencies": { - "@types/eslint": "^8.56.5", - "@types/estree": "^1.0.5", - "@typescript-eslint/types": "^7.2.0", "comment-parser": "1.4.1", - "esquery": "^1.5.0", + "esquery": "^1.6.0", "jsdoc-type-pratt-parser": "~4.0.0" }, "engines": { @@ -6533,9 +6531,9 @@ "license": "0BSD" }, "node_modules/@nx/nx-darwin-arm64": { - "version": "19.5.1", - "resolved": "https://registry.npmjs.org/@nx/nx-darwin-arm64/-/nx-darwin-arm64-19.5.1.tgz", - "integrity": "sha512-mdFSnwf+cEGZQ0HDJIzHBOWmho66VUN44qsDRPVSwpaEqlHSlcbiqKzM0+oVx9CRDLNQoYtYs1Y3hGlnag1sCQ==", + "version": "19.5.3", + "resolved": "https://registry.npmjs.org/@nx/nx-darwin-arm64/-/nx-darwin-arm64-19.5.3.tgz", + "integrity": "sha512-DacVfnhx7wiglDXRAdbrmaP4s3ZQXMs8Mk0fGoQYjv1uwWajDOPxMYJUZH0CGysIDADSrku4AIqogGX/CZjSuQ==", "cpu": [ "arm64" ], @@ -6682,9 +6680,9 @@ } }, "node_modules/@nx/nx-win32-x64-msvc": { - "version": "19.5.1", - "resolved": "https://registry.npmjs.org/@nx/nx-win32-x64-msvc/-/nx-win32-x64-msvc-19.5.1.tgz", - "integrity": "sha512-bxj12iAuyEwBCV6A+C8nXQ55KNji4L0VrL3y2KeH0wOeBMgTeKQxoMNk0/Ty2O6354YkAgwaKRHJMnM/LfO+og==", + "version": "19.5.3", + "resolved": "https://registry.npmjs.org/@nx/nx-win32-x64-msvc/-/nx-win32-x64-msvc-19.5.3.tgz", + "integrity": "sha512-DOdO7K6ySiwrXsnJNjJXxng427n5+nXIDt4L81ltCdr6oE8wUiUpRTt1dfl65rHknojB/b1at3V6+x450F0/2A==", "cpu": [ "x64" ], @@ -11898,9 +11896,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001642", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001642.tgz", - "integrity": "sha512-3XQ0DoRgLijXJErLSl+bLnJ+Et4KqV1PY6JJBGAFlsNsz31zeAIncyeZfLCabHK/jtSh+671RM9YMldxjUPZtA==", + "version": "1.0.30001645", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001645.tgz", + "integrity": "sha512-GFtY2+qt91kzyMk6j48dJcwJVq5uTkk71XxE3RtScx7XWRLsO7bU44LOFkOZYR8w9YMS0UhPSYpN/6rAMImmLw==", "dev": true, "funding": [ { @@ -11915,7 +11913,8 @@ "type": "github", "url": "https://github.com/sponsors/ai" } - ] + ], + "license": "CC-BY-4.0" }, "node_modules/canvas": { "version": "2.11.2", @@ -13629,16 +13628,17 @@ } }, "node_modules/cpy": { - "version": "11.0.1", + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/cpy/-/cpy-11.1.0.tgz", + "integrity": "sha512-QGHetPSSuprVs+lJmMDcivvrBwTKASzXQ5qxFvRC2RFESjjod71bDvFvhxTjDgkNjrrb72AI6JPjfYwxrIy33A==", "dev": true, - "license": "MIT", "dependencies": { "copy-file": "^11.0.0", - "globby": "^13.2.2", + "globby": "^14.0.2", "junk": "^4.0.1", - "micromatch": "^4.0.5", - "p-filter": "^3.0.0", - "p-map": "^6.0.0" + "micromatch": "^4.0.7", + "p-filter": "^4.1.0", + "p-map": "^7.0.2" }, "engines": { "node": ">=18" @@ -13727,30 +13727,28 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/cpy/node_modules/globby": { - "version": "13.2.2", + "node_modules/cpy/node_modules/p-filter": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/p-filter/-/p-filter-4.1.0.tgz", + "integrity": "sha512-37/tPdZ3oJwHaS3gNJdenCDB3Tz26i9sjhnguBtvN0vYlRIiDNnvTWkuh+0hETV9rLPdJ3rlL3yVOYPIAnM8rw==", "dev": true, - "license": "MIT", "dependencies": { - "dir-glob": "^3.0.1", - "fast-glob": "^3.3.0", - "ignore": "^5.2.4", - "merge2": "^1.4.1", - "slash": "^4.0.0" + "p-map": "^7.0.1" }, "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/cpy/node_modules/slash": { - "version": "4.0.0", + "node_modules/cpy/node_modules/p-map": { + "version": "7.0.2", + "resolved": "https://registry.npmjs.org/p-map/-/p-map-7.0.2.tgz", + "integrity": "sha512-z4cYYMMdKHzw4O5UkWJImbZynVIo0lSGTXc7bzB1e/rrDqkgGUNysK/o4bTr+0+xKvvLoTyGqYC4Fgljy9qe1Q==", "dev": true, - "license": "MIT", "engines": { - "node": ">=12" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -15669,21 +15667,21 @@ } }, "node_modules/eslint-plugin-jsdoc": { - "version": "48.4.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-48.4.0.tgz", - "integrity": "sha512-xBUxuAx03cKoEA7y+MYSUdwyN8AJyZHbAJ257sOFXgVgCScm574S4zEYJpBoARwaCu4chhCbvA+gdm+00whlxA==", + "version": "48.8.3", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-48.8.3.tgz", + "integrity": "sha512-AtIvwwW9D17MRkM0Z0y3/xZYaa9mdAvJrkY6fU/HNUwGbmMtHVvK4qRM9CDixGVtfNrQitb8c6zQtdh6cTOvLg==", "dev": true, "dependencies": { - "@es-joy/jsdoccomment": "~0.43.1", + "@es-joy/jsdoccomment": "~0.46.0", "are-docs-informative": "^0.0.2", "comment-parser": "1.4.1", - "debug": "^4.3.4", + "debug": "^4.3.5", "escape-string-regexp": "^4.0.0", - "esquery": "^1.5.0", - "parse-imports": "^2.1.0", - "semver": "^7.6.2", + "esquery": "^1.6.0", + "parse-imports": "^2.1.1", + "semver": "^7.6.3", "spdx-expression-parse": "^4.0.0", - "synckit": "^0.9.0" + "synckit": "^0.9.1" }, "engines": { "node": ">=18" @@ -15692,10 +15690,28 @@ "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0" } }, + "node_modules/eslint-plugin-jsdoc/node_modules/debug": { + "version": "4.3.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz", + "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==", + "dev": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, "node_modules/eslint-plugin-jsdoc/node_modules/escape-string-regexp": { "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", "dev": true, - "license": "MIT", "engines": { "node": ">=10" }, @@ -16186,8 +16202,9 @@ } }, "node_modules/esquery": { - "version": "1.5.0", - "license": "BSD-3-Clause", + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.6.0.tgz", + "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", "dependencies": { "estraverse": "^5.1.0" }, @@ -25858,23 +25875,6 @@ } } }, - "node_modules/nx/node_modules/@nx/nx-darwin-arm64": { - "version": "19.5.3", - "resolved": "https://registry.npmjs.org/@nx/nx-darwin-arm64/-/nx-darwin-arm64-19.5.3.tgz", - "integrity": "sha512-DacVfnhx7wiglDXRAdbrmaP4s3ZQXMs8Mk0fGoQYjv1uwWajDOPxMYJUZH0CGysIDADSrku4AIqogGX/CZjSuQ==", - "cpu": [ - "arm64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "darwin" - ], - "engines": { - "node": ">= 10" - } - }, "node_modules/nx/node_modules/@nx/nx-linux-x64-gnu": { "version": "19.5.3", "resolved": "https://registry.npmjs.org/@nx/nx-linux-x64-gnu/-/nx-linux-x64-gnu-19.5.3.tgz", @@ -25892,23 +25892,6 @@ "node": ">= 10" } }, - "node_modules/nx/node_modules/@nx/nx-win32-x64-msvc": { - "version": "19.5.3", - "resolved": "https://registry.npmjs.org/@nx/nx-win32-x64-msvc/-/nx-win32-x64-msvc-19.5.3.tgz", - "integrity": "sha512-DOdO7K6ySiwrXsnJNjJXxng427n5+nXIDt4L81ltCdr6oE8wUiUpRTt1dfl65rHknojB/b1at3V6+x450F0/2A==", - "cpu": [ - "x64" - ], - "dev": true, - "license": "MIT", - "optional": true, - "os": [ - "win32" - ], - "engines": { - "node": ">= 10" - } - }, "node_modules/nx/node_modules/ansi-styles": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", @@ -35897,9 +35880,10 @@ }, "packages/calcite-components": { "name": "@esri/calcite-components", - "version": "2.11.0-next.29", + "version": "2.11.0", "license": "SEE LICENSE.md", "dependencies": { + "@esri/calcite-ui-icons": "3.30.0", "@floating-ui/dom": "1.6.8", "@stencil/core": "4.19.2", "@types/color": "3.0.6", @@ -39076,10 +39060,10 @@ }, "packages/calcite-components-angular/projects/component-library": { "name": "@esri/calcite-components-angular", - "version": "2.11.0-next.29", + "version": "2.11.0", "license": "SEE LICENSE.md", "dependencies": { - "@esri/calcite-components": "^2.11.0-next.29", + "@esri/calcite-components": "^2.11.0", "tslib": "2.6.3" }, "peerDependencies": { @@ -39089,10 +39073,10 @@ }, "packages/calcite-components-react": { "name": "@esri/calcite-components-react", - "version": "2.11.0-next.29", + "version": "2.11.0", "license": "SEE LICENSE.md", "dependencies": { - "@esri/calcite-components": "^2.11.0-next.29" + "@esri/calcite-components": "^2.11.0" }, "peerDependencies": { "react": ">=16.7", @@ -39526,7 +39510,7 @@ }, "packages/calcite-ui-icons": { "name": "@esri/calcite-ui-icons", - "version": "3.29.1-next.0", + "version": "3.30.0", "license": "SEE LICENSE.md", "bin": { "spriter": "bin/spriter.js" diff --git a/package.json b/package.json index 0c2b1186329..de0b7c8264a 100644 --- a/package.json +++ b/package.json @@ -80,14 +80,14 @@ "chromatic": "11.5.6", "concurrently": "8.2.2", "conventional-changelog-conventionalcommits": "7.0.2", - "cpy": "11.0.1", + "cpy": "11.1.0", "cpy-cli": "5.0.0", "dedent": "1.5.3", "eslint": "8.57.0", "eslint-config-prettier": "9.1.0", "eslint-plugin-import": "2.29.1", "eslint-plugin-jest": "28.6.0", - "eslint-plugin-jsdoc": "48.4.0", + "eslint-plugin-jsdoc": "48.8.3", "eslint-plugin-prettier": "5.1.3", "eslint-plugin-react": "7.34.4", "eslint-plugin-unicorn": "54.0.0", @@ -135,8 +135,8 @@ "patch-package": "8.0.0" }, "optionalDependencies": { - "@nx/nx-darwin-arm64": "19.5.1", + "@nx/nx-darwin-arm64": "19.5.3", "@nx/nx-linux-x64-gnu": "18.3.5", - "@nx/nx-win32-x64-msvc": "19.5.1" + "@nx/nx-win32-x64-msvc": "19.5.3" } } diff --git a/packages/calcite-components-angular/projects/component-library/CHANGELOG.md b/packages/calcite-components-angular/projects/component-library/CHANGELOG.md index 4445a96ef28..eaf86b5ec97 100644 --- a/packages/calcite-components-angular/projects/component-library/CHANGELOG.md +++ b/packages/calcite-components-angular/projects/component-library/CHANGELOG.md @@ -3,137 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. -## [2.11.0-next.29](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.28...@esri/calcite-components-angular@2.11.0-next.29) (2024-07-30) +## [2.11.0](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.10.1...@esri/calcite-components-angular@2.11.0) (2024-07-31) -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.28](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.27...@esri/calcite-components-angular@2.11.0-next.28) (2024-07-30) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.27](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.26...@esri/calcite-components-angular@2.11.0-next.27) (2024-07-29) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.26](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.25...@esri/calcite-components-angular@2.11.0-next.26) (2024-07-29) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.25](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.24...@esri/calcite-components-angular@2.11.0-next.25) (2024-07-26) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.24](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.23...@esri/calcite-components-angular@2.11.0-next.24) (2024-07-25) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.23](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.22...@esri/calcite-components-angular@2.11.0-next.23) (2024-07-25) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.22](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.21...@esri/calcite-components-angular@2.11.0-next.22) (2024-07-25) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.21](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.20...@esri/calcite-components-angular@2.11.0-next.21) (2024-07-23) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.20](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.19...@esri/calcite-components-angular@2.11.0-next.20) (2024-07-23) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.19](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.18...@esri/calcite-components-angular@2.11.0-next.19) (2024-07-23) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.18](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.17...@esri/calcite-components-angular@2.11.0-next.18) (2024-07-22) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.17](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.16...@esri/calcite-components-angular@2.11.0-next.17) (2024-07-22) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.16](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.15...@esri/calcite-components-angular@2.11.0-next.16) (2024-07-22) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.15](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.14...@esri/calcite-components-angular@2.11.0-next.15) (2024-07-19) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.14](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.13...@esri/calcite-components-angular@2.11.0-next.14) (2024-07-16) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.13](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.12...@esri/calcite-components-angular@2.11.0-next.13) (2024-07-16) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.12](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.11...@esri/calcite-components-angular@2.11.0-next.12) (2024-07-16) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.11](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.10...@esri/calcite-components-angular@2.11.0-next.11) (2024-07-16) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.10](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.9...@esri/calcite-components-angular@2.11.0-next.10) (2024-07-15) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.9](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.8...@esri/calcite-components-angular@2.11.0-next.9) (2024-07-15) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.8](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.7...@esri/calcite-components-angular@2.11.0-next.8) (2024-07-15) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.7](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.6...@esri/calcite-components-angular@2.11.0-next.7) (2024-07-15) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.6](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.5...@esri/calcite-components-angular@2.11.0-next.6) (2024-07-12) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.5](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.4...@esri/calcite-components-angular@2.11.0-next.5) (2024-07-12) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.4](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.3...@esri/calcite-components-angular@2.11.0-next.4) (2024-07-12) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.3](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.2...@esri/calcite-components-angular@2.11.0-next.3) (2024-07-11) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.2](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.1...@esri/calcite-components-angular@2.11.0-next.2) (2024-07-08) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.11.0-next.0...@esri/calcite-components-angular@2.11.0-next.1) (2024-07-05) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.11.0-next.0](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.10.2-next.2...@esri/calcite-components-angular@2.11.0-next.0) (2024-07-02) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.10.2-next.2](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.10.2-next.1...@esri/calcite-components-angular@2.10.2-next.2) (2024-07-01) - -**Note:** Version bump only for package @esri/calcite-components-angular - -## [2.10.2-next.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.10.2-next.0...@esri/calcite-components-angular@2.10.2-next.1) (2024-07-01) +### Miscellaneous Chores -**Note:** Version bump only for package @esri/calcite-components-angular +- **@esri/calcite-components-angular:** Synchronize components versions -## [2.10.2-next.0](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.10.1-next.0...@esri/calcite-components-angular@2.10.2-next.0) (2024-06-28) +### Dependencies -**Note:** Version bump only for package @esri/calcite-components-angular +- The following workspace dependencies were updated + - dependencies + - @esri/calcite-components bumped from ^2.11.0-next.30 to ^2.11.0 ## [2.10.1](https://github.com/esri/calcite-design-system/compare/@esri/calcite-components-angular@2.10.0...@esri/calcite-components-angular@2.10.1) (2024-06-27) diff --git a/packages/calcite-components-angular/projects/component-library/package.json b/packages/calcite-components-angular/projects/component-library/package.json index e9f0a69d9be..bb3212b2bae 100644 --- a/packages/calcite-components-angular/projects/component-library/package.json +++ b/packages/calcite-components-angular/projects/component-library/package.json @@ -1,6 +1,6 @@ { "name": "@esri/calcite-components-angular", - "version": "2.11.0-next.29", + "version": "2.11.0", "description": "A set of Angular components that wrap Esri's Calcite Components.", "homepage": "https://developers.arcgis.com/calcite-design-system/", "bugs": { @@ -17,7 +17,7 @@ }, "sideEffects": false, "dependencies": { - "@esri/calcite-components": "^2.11.0-next.29", + "@esri/calcite-components": "^2.11.0", "tslib": "2.6.3" }, "peerDependencies": { diff --git a/packages/calcite-components-react/CHANGELOG.md b/packages/calcite-components-react/CHANGELOG.md index 4deef69ed73..963e7365f2b 100644 --- a/packages/calcite-components-react/CHANGELOG.md +++ b/packages/calcite-components-react/CHANGELOG.md @@ -3,137 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. -## [2.11.0-next.29](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.28...@esri/calcite-components-react@2.11.0-next.29) (2024-07-30) +## [2.11.0](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.10.1...@esri/calcite-components-react@2.11.0) (2024-07-31) -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.28](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.27...@esri/calcite-components-react@2.11.0-next.28) (2024-07-30) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.27](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.26...@esri/calcite-components-react@2.11.0-next.27) (2024-07-29) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.26](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.25...@esri/calcite-components-react@2.11.0-next.26) (2024-07-29) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.25](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.24...@esri/calcite-components-react@2.11.0-next.25) (2024-07-26) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.24](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.23...@esri/calcite-components-react@2.11.0-next.24) (2024-07-25) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.23](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.22...@esri/calcite-components-react@2.11.0-next.23) (2024-07-25) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.22](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.21...@esri/calcite-components-react@2.11.0-next.22) (2024-07-25) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.21](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.20...@esri/calcite-components-react@2.11.0-next.21) (2024-07-23) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.20](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.19...@esri/calcite-components-react@2.11.0-next.20) (2024-07-23) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.19](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.18...@esri/calcite-components-react@2.11.0-next.19) (2024-07-23) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.18](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.17...@esri/calcite-components-react@2.11.0-next.18) (2024-07-22) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.17](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.16...@esri/calcite-components-react@2.11.0-next.17) (2024-07-22) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.16](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.15...@esri/calcite-components-react@2.11.0-next.16) (2024-07-22) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.15](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.14...@esri/calcite-components-react@2.11.0-next.15) (2024-07-19) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.14](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.13...@esri/calcite-components-react@2.11.0-next.14) (2024-07-16) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.13](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.12...@esri/calcite-components-react@2.11.0-next.13) (2024-07-16) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.12](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.11...@esri/calcite-components-react@2.11.0-next.12) (2024-07-16) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.11](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.10...@esri/calcite-components-react@2.11.0-next.11) (2024-07-16) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.10](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.9...@esri/calcite-components-react@2.11.0-next.10) (2024-07-15) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.9](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.8...@esri/calcite-components-react@2.11.0-next.9) (2024-07-15) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.8](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.7...@esri/calcite-components-react@2.11.0-next.8) (2024-07-15) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.7](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.6...@esri/calcite-components-react@2.11.0-next.7) (2024-07-15) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.6](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.5...@esri/calcite-components-react@2.11.0-next.6) (2024-07-12) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.5](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.4...@esri/calcite-components-react@2.11.0-next.5) (2024-07-12) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.4](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.3...@esri/calcite-components-react@2.11.0-next.4) (2024-07-12) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.3](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.2...@esri/calcite-components-react@2.11.0-next.3) (2024-07-11) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.2](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.1...@esri/calcite-components-react@2.11.0-next.2) (2024-07-08) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.11.0-next.0...@esri/calcite-components-react@2.11.0-next.1) (2024-07-05) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.11.0-next.0](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.10.2-next.2...@esri/calcite-components-react@2.11.0-next.0) (2024-07-02) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.10.2-next.2](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.10.2-next.1...@esri/calcite-components-react@2.10.2-next.2) (2024-07-01) - -**Note:** Version bump only for package @esri/calcite-components-react - -## [2.10.2-next.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.10.2-next.0...@esri/calcite-components-react@2.10.2-next.1) (2024-07-01) +### Miscellaneous Chores -**Note:** Version bump only for package @esri/calcite-components-react +- **@esri/calcite-components-react:** Synchronize components versions -## [2.10.2-next.0](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.10.1-next.0...@esri/calcite-components-react@2.10.2-next.0) (2024-06-28) +### Dependencies -**Note:** Version bump only for package @esri/calcite-components-react +- The following workspace dependencies were updated + - dependencies + - @esri/calcite-components bumped from ^2.11.0-next.30 to ^2.11.0 ## [2.10.1](https://github.com/esri/calcite-design-system/compare/@esri/calcite-components-react@2.10.0...@esri/calcite-components-react@2.10.1) (2024-06-27) diff --git a/packages/calcite-components-react/package.json b/packages/calcite-components-react/package.json index ae308ee56ba..c494d46cefa 100644 --- a/packages/calcite-components-react/package.json +++ b/packages/calcite-components-react/package.json @@ -1,6 +1,6 @@ { "name": "@esri/calcite-components-react", - "version": "2.11.0-next.29", + "version": "2.11.0", "description": "A set of React components that wrap calcite components", "homepage": "https://developers.arcgis.com/calcite-design-system/", "repository": { @@ -28,7 +28,7 @@ "tsc": "tsc" }, "dependencies": { - "@esri/calcite-components": "^2.11.0-next.29" + "@esri/calcite-components": "^2.11.0" }, "peerDependencies": { "react": ">=16.7", diff --git a/packages/calcite-components/CHANGELOG.md b/packages/calcite-components/CHANGELOG.md index 250de1f20a8..54b94e90ded 100644 --- a/packages/calcite-components/CHANGELOG.md +++ b/packages/calcite-components/CHANGELOG.md @@ -3,216 +3,60 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. -## [2.11.0-next.29](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.28...@esri/calcite-components@2.11.0-next.29) (2024-07-30) - -### Bug Fixes - -- **dialog:** fix menu positioning when when overlayPositioning is 'fixed' and menuOpen is true ([#9891](https://github.com/Esri/calcite-design-system/issues/9891)) ([6911682](https://github.com/Esri/calcite-design-system/commit/69116826923b31259c36cdf1c262128763c1b016)), closes [#9876](https://github.com/Esri/calcite-design-system/issues/9876) -- improve browser check to resolve SSR errors ([#9897](https://github.com/Esri/calcite-design-system/issues/9897)) ([94683e3](https://github.com/Esri/calcite-design-system/commit/94683e3de58e2b24d05f605770eef7f5b599d835)), closes [#9242](https://github.com/Esri/calcite-design-system/issues/9242) -- **input-date-picker:** ensure initial value is in range ([#9894](https://github.com/Esri/calcite-design-system/issues/9894)) ([b7b1705](https://github.com/Esri/calcite-design-system/commit/b7b17058e15815634f4f4acdc83c8e5e3e649c50)), closes [#9282](https://github.com/Esri/calcite-design-system/issues/9282) - -## [2.11.0-next.28](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.27...@esri/calcite-components@2.11.0-next.28) (2024-07-30) - -### Features - -- **shell-panel:** deprecate float displayMode and add float-content and float-all ([#9795](https://github.com/Esri/calcite-design-system/issues/9795)) ([9beb6eb](https://github.com/Esri/calcite-design-system/commit/9beb6eba2971b3f06d9e4ee3c625c276561b9542)), closes [#7513](https://github.com/Esri/calcite-design-system/issues/7513) - -## [2.11.0-next.27](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.26...@esri/calcite-components@2.11.0-next.27) (2024-07-29) - -### Bug Fixes - -- **tooltip:** allow focusing on a reference element and then clicking on a tooltip ([#9878](https://github.com/Esri/calcite-design-system/issues/9878)) ([af467a1](https://github.com/Esri/calcite-design-system/commit/af467a16fd10788e103e96ab6c19cff3ee9af6b9)), closes [#9840](https://github.com/Esri/calcite-design-system/issues/9840) - -## [2.11.0-next.26](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.25...@esri/calcite-components@2.11.0-next.26) (2024-07-29) - -### Features - -- **combobox-item:** apply heading color according to updated spec ([#9883](https://github.com/Esri/calcite-design-system/issues/9883)) ([d8ddf57](https://github.com/Esri/calcite-design-system/commit/d8ddf57eec1b9aa009cbe1c18b3c8146fc54b1ca)), closes [#9881](https://github.com/Esri/calcite-design-system/issues/9881) -- **dialog:** add padding to default slot ([#9871](https://github.com/Esri/calcite-design-system/issues/9871)) ([9f06123](https://github.com/Esri/calcite-design-system/commit/9f06123ac2f5b152ce2f27a2ca64f46e212c5a9b)), closes [#9869](https://github.com/Esri/calcite-design-system/issues/9869) - -### Bug Fixes - -- **panel:** correct footer padding and layout ([#9868](https://github.com/Esri/calcite-design-system/issues/9868)) ([b25a0ae](https://github.com/Esri/calcite-design-system/commit/b25a0ae7427613c9b75dd763327f622894ca1d22)), closes [#9858](https://github.com/Esri/calcite-design-system/issues/9858) [#9857](https://github.com/Esri/calcite-design-system/issues/9857) -- **tab-title:** Adjust hover styling for `bordered` Tab Title ([#9867](https://github.com/Esri/calcite-design-system/issues/9867)) ([2c62917](https://github.com/Esri/calcite-design-system/commit/2c629172c3f5f6facbe9d9424daaae9f5dbdf344)), closes [#9854](https://github.com/Esri/calcite-design-system/issues/9854) - -## [2.11.0-next.25](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.24...@esri/calcite-components@2.11.0-next.25) (2024-07-26) - -### Features - -- **dialog:** adds new dialog component and deprecates the modal component ([#9751](https://github.com/Esri/calcite-design-system/issues/9751)) ([0cdd327](https://github.com/Esri/calcite-design-system/commit/0cdd327438f43248b33a5244a2fb18c31b92d582)), closes [#7886](https://github.com/Esri/calcite-design-system/issues/7886) - -## [2.11.0-next.24](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.23...@esri/calcite-components@2.11.0-next.24) (2024-07-25) - -### Bug Fixes - -- **panel, flow-item:** prevent footer slots from conflicting with each other ([#9856](https://github.com/Esri/calcite-design-system/issues/9856)) ([f3a26b6](https://github.com/Esri/calcite-design-system/commit/f3a26b6074f702cfc3c2638302cf4454a2a99a3d)), closes [#9855](https://github.com/Esri/calcite-design-system/issues/9855) - -## [2.11.0-next.23](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.22...@esri/calcite-components@2.11.0-next.23) (2024-07-25) - -### Bug Fixes - -- **carousel:** Prevent duplicate animation when navigating via keyboard ([#9848](https://github.com/Esri/calcite-design-system/issues/9848)) ([37229a5](https://github.com/Esri/calcite-design-system/commit/37229a5de4a6338c6d921d2def6afc38300bf636)), closes [#9471](https://github.com/Esri/calcite-design-system/issues/9471) - -## [2.11.0-next.22](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.21...@esri/calcite-components@2.11.0-next.22) (2024-07-25) - -### Bug Fixes - -- **shell:** fix resizing a slotted shell-panel when clicking to resize ([#9846](https://github.com/Esri/calcite-design-system/issues/9846)) ([2318905](https://github.com/Esri/calcite-design-system/commit/23189059dd8a0efa4e665c5a10d2dc1568e0d6ef)), closes [#9807](https://github.com/Esri/calcite-design-system/issues/9807) -- **tabs:** Update tab title indicator display ([#9666](https://github.com/Esri/calcite-design-system/issues/9666)) ([d570023](https://github.com/Esri/calcite-design-system/commit/d570023ab447b6ba6694c38b611efae4db2cc0eb)), closes [#8800](https://github.com/Esri/calcite-design-system/issues/8800) [#8772](https://github.com/Esri/calcite-design-system/issues/8772) - -## [2.11.0-next.21](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.20...@esri/calcite-components@2.11.0-next.21) (2024-07-23) +## [2.11.0](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.10.1...@esri/calcite-components@2.11.0) (2024-07-31) ### Features -- **combobox:** append custom values to top of dropdown ([#9817](https://github.com/Esri/calcite-design-system/issues/9817)) ([287448b](https://github.com/Esri/calcite-design-system/commit/287448b432d0e93b0b183282cca07867ab29a678)), closes [#7288](https://github.com/Esri/calcite-design-system/issues/7288) - -## [2.11.0-next.20](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.19...@esri/calcite-components@2.11.0-next.20) (2024-07-23) +- **chip:** Enhance multi-select group affordance ([#9286](https://github.com/Esri/calcite-design-system/issues/9286)) ([fd150e1](https://github.com/Esri/calcite-design-system/commit/fd150e1ef6fdce71a25dfad6355d1963c81b6474)) +- **color-picker, color-picker-hex-input:** Add input auto commit, blur and auto select enhancements. ([#9701](https://github.com/Esri/calcite-design-system/issues/9701)) ([b2be625](https://github.com/Esri/calcite-design-system/commit/b2be62566821e36b985d133b1c867b3cfb51fa84)) +- **combobox-item:** Apply heading color according to updated spec ([#9883](https://github.com/Esri/calcite-design-system/issues/9883)) ([9f642ff](https://github.com/Esri/calcite-design-system/commit/9f642fffba76555d3cb91aa0a05bb2e026f1cc58)) +- **combobox, combobox-item:** Add `description`, `shortHeading` props and `content-end` slot ([#9771](https://github.com/Esri/calcite-design-system/issues/9771)) ([78eb555](https://github.com/Esri/calcite-design-system/commit/78eb5557deee8c04d857f79061d29d35bc2473ee)) +- **combobox, combobox-item:** Add `metadata` support for filtering ([#9819](https://github.com/Esri/calcite-design-system/issues/9819)) ([5de7787](https://github.com/Esri/calcite-design-system/commit/5de778772c7e99a643598e1c3c829498f98865c1)) +- **combobox:** Append custom values to top of dropdown ([#9817](https://github.com/Esri/calcite-design-system/issues/9817)) ([bd55097](https://github.com/Esri/calcite-design-system/commit/bd55097cb09f9cedc5cc57ecd9c2ac9ce662ee54)) +- **dialog:** Add padding to default slot ([#9871](https://github.com/Esri/calcite-design-system/issues/9871)) ([9d89d1d](https://github.com/Esri/calcite-design-system/commit/9d89d1d5a791b899bd07ce3c01203d443e684f99)) +- **dialog:** Adds new dialog component and deprecates the modal component ([#9751](https://github.com/Esri/calcite-design-system/issues/9751)) ([0111c23](https://github.com/Esri/calcite-design-system/commit/0111c236a30aebe55654ee442134962df3d62042)) +- **icon:** Type icon names ([#9650](https://github.com/Esri/calcite-design-system/issues/9650)) ([7513f3a](https://github.com/Esri/calcite-design-system/commit/7513f3a2b870bb13e8937fd1c3ac1f80fd350908)) +- **panel, flow-item:** Add alerts slot ([#9778](https://github.com/Esri/calcite-design-system/issues/9778)) ([8b9b820](https://github.com/Esri/calcite-design-system/commit/8b9b820611e653b9fffd8602ed8458eb790504ba)) +- **panel, flow-item:** Add beforeClose property ([#9770](https://github.com/Esri/calcite-design-system/issues/9770)) ([aefd3cb](https://github.com/Esri/calcite-design-system/commit/aefd3cb39d5f5eab7adb94d1d1617ebc51bc80be)) +- **panel, flow-item:** Add scale property ([#9730](https://github.com/Esri/calcite-design-system/issues/9730)) ([27c597e](https://github.com/Esri/calcite-design-system/commit/27c597e87e7f5ebce98899062e775e8aed3ba52c)) +- Provide info message on stamped version instead of warning ([#9739](https://github.com/Esri/calcite-design-system/issues/9739)) ([b25cb7b](https://github.com/Esri/calcite-design-system/commit/b25cb7b4d7a328115d66bc2f897d8c1bbdadeab8)) +- **shell-panel:** Deprecate float displayMode and add float-content and float-all ([#9795](https://github.com/Esri/calcite-design-system/issues/9795)) ([bf93728](https://github.com/Esri/calcite-design-system/commit/bf93728a507360a6b479f8b14d6da52ce517415f)) +- **tooltip:** Support touch events ([#9487](https://github.com/Esri/calcite-design-system/issues/9487)) ([633706b](https://github.com/Esri/calcite-design-system/commit/633706b07ee56c646b126e33c99afe7292f9db04)) ### Bug Fixes -- **time-picker:** render meridiem first for korean locale ([#9842](https://github.com/Esri/calcite-design-system/issues/9842)) ([6ed4d21](https://github.com/Esri/calcite-design-system/commit/6ed4d21d9429a42389657cce6d65ac814ac02a16)), closes [#9720](https://github.com/Esri/calcite-design-system/issues/9720) +- **block-section:** Apply missing CSS class to start/end icon ([#9688](https://github.com/Esri/calcite-design-system/issues/9688)) ([2169ed2](https://github.com/Esri/calcite-design-system/commit/2169ed2ac3e5614274e23d2005c90f22e95e6f57)) +- **block:** Remove top padding when no heading is defined ([#9782](https://github.com/Esri/calcite-design-system/issues/9782)) ([704f5df](https://github.com/Esri/calcite-design-system/commit/704f5dfbe47b8cc0e6b6b5f2a1689a4827379f84)) +- **carousel:** Prevent duplicate animation when navigating via keyboard ([#9848](https://github.com/Esri/calcite-design-system/issues/9848)) ([cfdbd44](https://github.com/Esri/calcite-design-system/commit/cfdbd4484443457ddb791288e11d29f8bee1d9b3)) +- **combobox-item:** Tweak center content font-weight and spacing ([#9818](https://github.com/Esri/calcite-design-system/issues/9818)) ([a67c4af](https://github.com/Esri/calcite-design-system/commit/a67c4af175525d24ca146185a46b56bee775a55c)) +- **deps:** Move @types/sortablejs as a dependency so the public types resolve properly ([#9786](https://github.com/Esri/calcite-design-system/issues/9786)) ([3d47c52](https://github.com/Esri/calcite-design-system/commit/3d47c521ded02319f42f57a66182293881a416d9)) +- **dialog:** Fix menu positioning when when overlayPositioning is 'fixed' and menuOpen is true ([#9891](https://github.com/Esri/calcite-design-system/issues/9891)) ([4390177](https://github.com/Esri/calcite-design-system/commit/43901771755e8c151ab13ec5e23f6712ac5f83fe)) +- Fix issue in Firefox where disabled elements were incorrectly enabled when a sibling was enabled ([#9710](https://github.com/Esri/calcite-design-system/issues/9710)) ([cd4d52c](https://github.com/Esri/calcite-design-system/commit/cd4d52ce05e5f3301ff5e3ece966e2304bd96a68)) +- **flow-item:** Set closed property to true when internal panel is closed ([#9715](https://github.com/Esri/calcite-design-system/issues/9715)) ([f7d2a4f](https://github.com/Esri/calcite-design-system/commit/f7d2a4f8410c4c4a4174417f87d6585fa51e78b6)) +- Improve browser check to resolve SSR errors ([#9897](https://github.com/Esri/calcite-design-system/issues/9897)) ([bdb225b](https://github.com/Esri/calcite-design-system/commit/bdb225b6a430e47527b5a957a61c632895ae0f0c)) +- **input-date-picker:** Ensure initial value is in range ([#9894](https://github.com/Esri/calcite-design-system/issues/9894)) ([7d05134](https://github.com/Esri/calcite-design-system/commit/7d051344f598445d68c04bce09d7c1e9463884bd)) +- **input-number:** Restore decimal input mode default ([#9741](https://github.com/Esri/calcite-design-system/issues/9741)) ([1165dca](https://github.com/Esri/calcite-design-system/commit/1165dca7a84b313ff0c03039348597fcddd9da32)) +- **panel, flow-item:** Fix footer-padding CSS prop regression ([#9757](https://github.com/Esri/calcite-design-system/issues/9757)) ([f935790](https://github.com/Esri/calcite-design-system/commit/f935790d6952f167b969fe1443e8bc680731a558)) +- **panel, flow-item:** Prevent footer slots from conflicting with each other ([#9856](https://github.com/Esri/calcite-design-system/issues/9856)) ([cffaff8](https://github.com/Esri/calcite-design-system/commit/cffaff85fe7587398df613d084446533441ee7ab)) +- **panel:** Correct footer padding and layout ([#9868](https://github.com/Esri/calcite-design-system/issues/9868)) ([1e02ece](https://github.com/Esri/calcite-design-system/commit/1e02ecee51b3f81c0c19eedd7de9ef8f4b418fc0)) +- **radio-button-group:** Remove blank clickable space outside of label ([#9793](https://github.com/Esri/calcite-design-system/issues/9793)) ([4cc24a0](https://github.com/Esri/calcite-design-system/commit/4cc24a0dbb3b494e2361b185a8aba8be987a7188)) +- **segmented-control:** Make check state update correctly ([#9733](https://github.com/Esri/calcite-design-system/issues/9733)) ([602c922](https://github.com/Esri/calcite-design-system/commit/602c922e8a2e59e3dcb46928779143c8be3a8c2d)) +- **shell:** Fix resizing a slotted shell-panel when clicking to resize ([#9846](https://github.com/Esri/calcite-design-system/issues/9846)) ([326001c](https://github.com/Esri/calcite-design-system/commit/326001cd1eafaa0dd579e34d2e219efcdca58816)) +- **shell:** Update shell to correctly position calcite shell panel at shell's bottom ([#9748](https://github.com/Esri/calcite-design-system/issues/9748)) ([5959db7](https://github.com/Esri/calcite-design-system/commit/5959db790378634c1800a7bcdb94568ba8c1fadb)) +- **tab-title:** Adjust hover styling for `bordered` Tab Title ([#9867](https://github.com/Esri/calcite-design-system/issues/9867)) ([a77cd27](https://github.com/Esri/calcite-design-system/commit/a77cd27ef8cf3b512e56a226b91efcea3f5bff52)) +- **tabs:** Handle tab close events that remove the associated tab-title and tab elements from the DOM ([#9768](https://github.com/Esri/calcite-design-system/issues/9768)) ([bda619c](https://github.com/Esri/calcite-design-system/commit/bda619cdabcf8b25f269eb830d5ce2f7e649cabf)) +- **tabs:** Update tab title indicator display ([#9666](https://github.com/Esri/calcite-design-system/issues/9666)) ([5f0914b](https://github.com/Esri/calcite-design-system/commit/5f0914bd098cbc66e74111307ed1602851ee3880)) +- **tile:** Center align contentTop and contentBottom slots when alignment prop equals "center" ([#9732](https://github.com/Esri/calcite-design-system/issues/9732)) ([1a8393b](https://github.com/Esri/calcite-design-system/commit/1a8393b8cc6a50b915e28e722229457b07af83fd)) +- **tile:** Center align slot's text when alignment is equal to center ([#9773](https://github.com/Esri/calcite-design-system/issues/9773)) ([8611bfc](https://github.com/Esri/calcite-design-system/commit/8611bfcf72ede1725a44698eee19d3ef16eea933)) +- **time-picker:** Render meridiem first for korean locale ([#9842](https://github.com/Esri/calcite-design-system/issues/9842)) ([897f924](https://github.com/Esri/calcite-design-system/commit/897f9248ddac7b878a0daaa993fc3136363986b7)) +- **tooltip:** Allow focusing on a reference element and then clicking on a tooltip ([#9878](https://github.com/Esri/calcite-design-system/issues/9878)) ([dfca2d4](https://github.com/Esri/calcite-design-system/commit/dfca2d4fe113c4a9321423749a170498fa13dfb3)) +- Widen icon type to allow string ([#9915](https://github.com/Esri/calcite-design-system/issues/9915)) ([44138b1](https://github.com/Esri/calcite-design-system/commit/44138b13b4df7413b19e6258cdae9bb18a9e7142)) -## [2.11.0-next.19](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.18...@esri/calcite-components@2.11.0-next.19) (2024-07-23) - -### Bug Fixes - -- **tabs:** handle tab close events that remove the associated tab-title and tab elements from the DOM ([#9768](https://github.com/Esri/calcite-design-system/issues/9768)) ([d945793](https://github.com/Esri/calcite-design-system/commit/d945793830940b578c21b6a48e592eb56503a1ad)), closes [#7155](https://github.com/Esri/calcite-design-system/issues/7155) - -## [2.11.0-next.18](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.17...@esri/calcite-components@2.11.0-next.18) (2024-07-22) - -### Bug Fixes - -- **combobox-item:** tweak center content font-weight and spacing ([#9818](https://github.com/Esri/calcite-design-system/issues/9818)) ([e2bddcf](https://github.com/Esri/calcite-design-system/commit/e2bddcf4374d043246b969106090f543add81c52)), closes [#3695](https://github.com/Esri/calcite-design-system/issues/3695) - -## [2.11.0-next.17](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.16...@esri/calcite-components@2.11.0-next.17) (2024-07-22) - -### Features - -- **combobox, combobox-item:** add `metadata` support for filtering ([#9819](https://github.com/Esri/calcite-design-system/issues/9819)) ([bd90f63](https://github.com/Esri/calcite-design-system/commit/bd90f638b6da0879b92dadbba6688e9590c8fe7f)), closes [#9796](https://github.com/Esri/calcite-design-system/issues/9796) - -## [2.11.0-next.16](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.15...@esri/calcite-components@2.11.0-next.16) (2024-07-22) - -### Features - -- **tooltip:** support touch events ([#9487](https://github.com/Esri/calcite-design-system/issues/9487)) ([77459fb](https://github.com/Esri/calcite-design-system/commit/77459fbfb54163dffb85e9ca1178e39938bf38eb)), closes [#9273](https://github.com/Esri/calcite-design-system/issues/9273) - -## [2.11.0-next.15](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.14...@esri/calcite-components@2.11.0-next.15) (2024-07-19) - -### Features - -- **color-picker, color-picker-hex-input:** Add input auto commit, blur and auto select enhancements. ([#9701](https://github.com/Esri/calcite-design-system/issues/9701)) ([281a869](https://github.com/Esri/calcite-design-system/commit/281a86954e266a554dfbbf96c0a641820f11dc56)), closes [#9624](https://github.com/Esri/calcite-design-system/issues/9624) - -## [2.11.0-next.14](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.13...@esri/calcite-components@2.11.0-next.14) (2024-07-16) - -### Bug Fixes - -- **radio-button-group:** remove blank clickable space outside of label ([#9793](https://github.com/Esri/calcite-design-system/issues/9793)) ([818a33e](https://github.com/Esri/calcite-design-system/commit/818a33edd8a8114b8a8a09f1bb8a5ad78fc9c8a0)), closes [#6703](https://github.com/Esri/calcite-design-system/issues/6703) - -## [2.11.0-next.13](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.12...@esri/calcite-components@2.11.0-next.13) (2024-07-16) - -### Bug Fixes - -- **deps:** move @types/sortablejs as a dependency so the public types resolve properly ([#9786](https://github.com/Esri/calcite-design-system/issues/9786)) ([e36268b](https://github.com/Esri/calcite-design-system/commit/e36268babbd311b3405d376063f0ae5fbb35f873)), closes [#9505](https://github.com/Esri/calcite-design-system/issues/9505) - -## [2.11.0-next.12](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.11...@esri/calcite-components@2.11.0-next.12) (2024-07-16) - -### Features - -- **combobox, combobox-item:** add `description`, `shortHeading` props and `content-end` slot ([#9771](https://github.com/Esri/calcite-design-system/issues/9771)) ([25a4778](https://github.com/Esri/calcite-design-system/commit/25a4778cf7ebbdcfbe6f7da7e0c86238e7cbf819)), closes [#3695](https://github.com/Esri/calcite-design-system/issues/3695) - -## [2.11.0-next.11](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.10...@esri/calcite-components@2.11.0-next.11) (2024-07-16) - -### Features - -- **panel, flow-item:** add alerts slot ([#9778](https://github.com/Esri/calcite-design-system/issues/9778)) ([5ba517c](https://github.com/Esri/calcite-design-system/commit/5ba517c9d934e88c393eab90e5c0d16da24c43b2)), closes [#9772](https://github.com/Esri/calcite-design-system/issues/9772) - -## [2.11.0-next.10](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.9...@esri/calcite-components@2.11.0-next.10) (2024-07-15) - -### Features - -- **chip:** enhance multi-select group affordance ([#9286](https://github.com/Esri/calcite-design-system/issues/9286)) ([93a17a1](https://github.com/Esri/calcite-design-system/commit/93a17a17c670aaa2a6f443ecc6b9d3fdfde859ac)), closes [#9055](https://github.com/Esri/calcite-design-system/issues/9055) [#7425](https://github.com/Esri/calcite-design-system/issues/7425) - -### Bug Fixes - -- **block:** remove top padding when no heading is defined ([#9782](https://github.com/Esri/calcite-design-system/issues/9782)) ([d71e064](https://github.com/Esri/calcite-design-system/commit/d71e0648b03f138cdef2e8e9f2868d849e1ed04a)), closes [#9753](https://github.com/Esri/calcite-design-system/issues/9753) - -## [2.11.0-next.9](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.8...@esri/calcite-components@2.11.0-next.9) (2024-07-15) - -### Features - -- provide info message on stamped version instead of warning ([#9739](https://github.com/Esri/calcite-design-system/issues/9739)) ([6ccb12a](https://github.com/Esri/calcite-design-system/commit/6ccb12a17ec371ba13fe144f8d37fdfb607dfce2)), closes [#9721](https://github.com/Esri/calcite-design-system/issues/9721) - -## [2.11.0-next.8](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.7...@esri/calcite-components@2.11.0-next.8) (2024-07-15) - -### Features - -- **panel, flow-item:** add beforeClose property ([#9770](https://github.com/Esri/calcite-design-system/issues/9770)) ([fe32441](https://github.com/Esri/calcite-design-system/commit/fe32441883f3c793e5994fec594325362e5bef61)), closes [#9769](https://github.com/Esri/calcite-design-system/issues/9769) - -## [2.11.0-next.7](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.6...@esri/calcite-components@2.11.0-next.7) (2024-07-15) - -### Bug Fixes - -- **tile:** center align slot's text when alignment is equal to center ([#9773](https://github.com/Esri/calcite-design-system/issues/9773)) ([4a26398](https://github.com/Esri/calcite-design-system/commit/4a263988b72faca473e993aebe0c7f61b12a6d19)), closes [#9540](https://github.com/Esri/calcite-design-system/issues/9540) - -## [2.11.0-next.6](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.5...@esri/calcite-components@2.11.0-next.6) (2024-07-12) - -### Bug Fixes - -- **shell:** update shell to correctly position calcite shell panel at shell's bottom ([#9748](https://github.com/Esri/calcite-design-system/issues/9748)) ([f56c625](https://github.com/Esri/calcite-design-system/commit/f56c625188c634b7fcc51d70f9e3ab2e287fda72)), closes [#8269](https://github.com/Esri/calcite-design-system/issues/8269) - -## [2.11.0-next.5](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.4...@esri/calcite-components@2.11.0-next.5) (2024-07-12) - -### Bug Fixes - -- **tile:** center align contentTop and contentBottom slots when alignment prop equals "center" ([#9732](https://github.com/Esri/calcite-design-system/issues/9732)) ([a462498](https://github.com/Esri/calcite-design-system/commit/a462498a0afd85a72cc78cdc8d119c582628247e)), closes [#9540](https://github.com/Esri/calcite-design-system/issues/9540) - -## [2.11.0-next.4](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.3...@esri/calcite-components@2.11.0-next.4) (2024-07-12) - -### Bug Fixes - -- **panel, flow-item:** fix footer-padding CSS prop regression ([#9757](https://github.com/Esri/calcite-design-system/issues/9757)) ([94b808c](https://github.com/Esri/calcite-design-system/commit/94b808c7238cf0ba183adc1ab365efdedaaaa7a7)) - -## [2.11.0-next.3](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.2...@esri/calcite-components@2.11.0-next.3) (2024-07-11) - -### Bug Fixes - -- **input-number:** restore decimal input mode default ([#9741](https://github.com/Esri/calcite-design-system/issues/9741)) ([9264011](https://github.com/Esri/calcite-design-system/commit/926401188ecf6f03b3e9b386863407172ceb0eab)), closes [#9740](https://github.com/Esri/calcite-design-system/issues/9740) - -## [2.11.0-next.2](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.1...@esri/calcite-components@2.11.0-next.2) (2024-07-08) - -### Features - -- **panel, flow-item:** add scale property ([#9730](https://github.com/Esri/calcite-design-system/issues/9730)) ([1cc65e7](https://github.com/Esri/calcite-design-system/commit/1cc65e73ba6ba1119f6f9890c6c4ecf23922c6ca)), closes [#6980](https://github.com/Esri/calcite-design-system/issues/6980) - -## [2.11.0-next.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.11.0-next.0...@esri/calcite-components@2.11.0-next.1) (2024-07-05) - -### Bug Fixes - -- **segmented-control:** Make check state update correctly ([#9733](https://github.com/Esri/calcite-design-system/issues/9733)) ([a2f3741](https://github.com/Esri/calcite-design-system/commit/a2f37415513a2f2e8471dcef982351b7c82b225b)), closes [#6860](https://github.com/Esri/calcite-design-system/issues/6860) - -## [2.11.0-next.0](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.10.2-next.2...@esri/calcite-components@2.11.0-next.0) (2024-07-02) - -### Features - -- **icon:** type icon names ([#9650](https://github.com/Esri/calcite-design-system/issues/9650)) ([9c2ba2f](https://github.com/Esri/calcite-design-system/commit/9c2ba2fb21f195387a8dc0a95009c620f070378d)), closes [#8858](https://github.com/Esri/calcite-design-system/issues/8858) - -## [2.10.2-next.2](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.10.2-next.1...@esri/calcite-components@2.10.2-next.2) (2024-07-01) - -### Bug Fixes - -- **block-section:** apply missing CSS class to start/end icon ([#9688](https://github.com/Esri/calcite-design-system/issues/9688)) ([bceeab5](https://github.com/Esri/calcite-design-system/commit/bceeab50480c5011505704eb80af85968eb5a972)), closes [#9703](https://github.com/Esri/calcite-design-system/issues/9703) - -## [2.10.2-next.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.10.2-next.0...@esri/calcite-components@2.10.2-next.1) (2024-07-01) - -### Bug Fixes - -- **flow-item:** set closed property to true when internal panel is closed ([#9715](https://github.com/Esri/calcite-design-system/issues/9715)) ([69661bc](https://github.com/Esri/calcite-design-system/commit/69661bcdee0f189fa9f7eed95fc98e584a115d06)), closes [#9714](https://github.com/Esri/calcite-design-system/issues/9714) - -## [2.10.2-next.0](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.10.1-next.0...@esri/calcite-components@2.10.2-next.0) (2024-06-28) - -### Bug Fixes +### Dependencies -- fix issue in Firefox where disabled elements were incorrectly enabled when a sibling was enabled ([#9710](https://github.com/Esri/calcite-design-system/issues/9710)) ([1d9abfc](https://github.com/Esri/calcite-design-system/commit/1d9abfce816716a1cbb2fd0ede73ce198babafa0)) +- The following workspace dependencies were updated + - dependencies + - @esri/calcite-ui-icons bumped from ^3.29.1-next.0 to ^3.30.0 ## [2.10.1](https://github.com/esri/calcite-design-system/compare/@esri/calcite-components@2.10.0...@esri/calcite-components@2.10.1) (2024-06-27) diff --git a/packages/calcite-components/package.json b/packages/calcite-components/package.json index 7445518e506..1665cc2f818 100644 --- a/packages/calcite-components/package.json +++ b/packages/calcite-components/package.json @@ -1,6 +1,6 @@ { "name": "@esri/calcite-components", - "version": "2.11.0-next.29", + "version": "2.11.0", "homepage": "https://developers.arcgis.com/calcite-design-system/", "description": "Web Components for Esri's Calcite Design System.", "main": "dist/index.cjs.js", @@ -61,6 +61,7 @@ "directory": "packages/calcite-components" }, "dependencies": { + "@esri/calcite-ui-icons": "3.30.0", "@floating-ui/dom": "1.6.8", "@stencil/core": "4.19.2", "@types/color": "3.0.6", diff --git a/packages/calcite-components/readme.md b/packages/calcite-components/readme.md index 458e15890e8..d4109a5acf0 100644 --- a/packages/calcite-components/readme.md +++ b/packages/calcite-components/readme.md @@ -17,12 +17,12 @@ The most common approach for loading Calcite Components is to use the version ho ```html ``` diff --git a/packages/calcite-components/src/components/accordion-item/readme.md b/packages/calcite-components/src/components/accordion-item/readme.md index 4c717c0853a..66683857b7b 100644 --- a/packages/calcite-components/src/components/accordion-item/readme.md +++ b/packages/calcite-components/src/components/accordion-item/readme.md @@ -6,14 +6,14 @@ For comprehensive guidance on using and implementing `calcite-accordion-item`, r ## Properties -| Property | Attribute | Description | Type | Default | -| ------------- | --------------- | ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `description` | `description` | Specifies a description for the component. | `string` | `undefined` | -| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` | -| `heading` | `heading` | Specifies heading text for the component. | `string` | `undefined` | -| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | +| Property | Attribute | Description | Type | Default | +| ------------- | --------------- | ----------------------------------------------------------------------------------------------------------- | ---------------------------- | ----------- | +| `description` | `description` | Specifies a description for the component. | `string` | `undefined` | +| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` | +| `heading` | `heading` | Specifies heading text for the component. | `string` | `undefined` | +| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | ## Methods diff --git a/packages/calcite-components/src/components/action-menu/readme.md b/packages/calcite-components/src/components/action-menu/readme.md index 45be8580e3c..6524b961ddd 100644 --- a/packages/calcite-components/src/components/action-menu/readme.md +++ b/packages/calcite-components/src/components/action-menu/readme.md @@ -12,7 +12,7 @@ | `label` *(required)* | `label` | Specifies the text string for the component. | `string` | `undefined` | | `open` | `open` | When `true`, the component is open. | `boolean` | `false` | | `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | -| `placement` | `placement` | Determines where the component will be positioned relative to the `referenceElement`. | `"auto" \| "top" \| "bottom" \| "left" \| "right" \| "top-start" \| "top-end" \| "bottom-start" \| "bottom-end" \| "left-start" \| "left-end" \| "right-start" \| "right-end" \| "leading" \| "trailing" \| "auto-start" \| "auto-end" \| "leading-start" \| "leading-end" \| "trailing-end" \| "trailing-start"` | `"auto"` | +| `placement` | `placement` | Determines where the component will be positioned relative to the `referenceElement`. | `"auto" \| "top" \| "bottom" \| "right" \| "left" \| "top-start" \| "top-end" \| "bottom-start" \| "bottom-end" \| "right-start" \| "right-end" \| "left-start" \| "left-end" \| "leading" \| "trailing" \| "auto-start" \| "auto-end" \| "leading-start" \| "leading-end" \| "trailing-end" \| "trailing-start"` | `"auto"` | | `scale` | `scale` | Specifies the size of the component's trigger `calcite-action`. | `"l" \| "m" \| "s"` | `undefined` | ## Events diff --git a/packages/calcite-components/src/components/action/readme.md b/packages/calcite-components/src/components/action/readme.md index fb79c36cb5d..78c083d1255 100755 --- a/packages/calcite-components/src/components/action/readme.md +++ b/packages/calcite-components/src/components/action/readme.md @@ -6,22 +6,22 @@ For comprehensive guidance on using and implementing `calcite-action`, refer to ## Properties -| Property | Attribute | Description | Type | Default | -| ------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `active` | `active` | When `true`, the component is highlighted. | `boolean` | `false` | -| `alignment` | `alignment` | Specifies the horizontal alignment of button elements with text content. | `"center" \| "end" \| "start"` | `undefined` | -| `appearance` | `appearance` | Specifies the appearance of the component. | `"solid" \| "transparent"` | `"solid"` | -| `compact` | `compact` | When `true`, the side padding of the component is reduced. Compact mode is used internally by components, e.g. `calcite-block-section`. | `boolean` | `false` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `icon` | `icon` | Specifies an icon to display. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | -| `indicator` | `indicator` | When `true`, displays a visual indicator. | `boolean` | `false` | -| `label` | `label` | Specifies the label of the component. If no label is provided, the label inherits what's provided for the `text` prop. | `string` | `undefined` | -| `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` | -| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ActionMessages` | `undefined` | -| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | -| `text` *(required)* | `text` | Specifies text that accompanies the icon. | `string` | `undefined` | -| `textEnabled` | `text-enabled` | Indicates whether the text is displayed. | `boolean` | `false` | +| Property | Attribute | Description | Type | Default | +| ------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | ----------- | +| `active` | `active` | When `true`, the component is highlighted. | `boolean` | `false` | +| `alignment` | `alignment` | Specifies the horizontal alignment of button elements with text content. | `"center" \| "end" \| "start"` | `undefined` | +| `appearance` | `appearance` | Specifies the appearance of the component. | `"solid" \| "transparent"` | `"solid"` | +| `compact` | `compact` | **[DEPRECATED]** No longer necessary.

When `true`, the side padding of the component is reduced. | `boolean` | `false` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `icon` | `icon` | Specifies an icon to display. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | +| `indicator` | `indicator` | When `true`, displays a visual indicator. | `boolean` | `false` | +| `label` | `label` | Specifies the label of the component. If no label is provided, the label inherits what's provided for the `text` prop. | `string` | `undefined` | +| `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` | +| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ActionMessages` | `undefined` | +| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | +| `text` *(required)* | `text` | Specifies text that accompanies the icon. | `string` | `undefined` | +| `textEnabled` | `text-enabled` | Indicates whether the text is displayed. | `boolean` | `false` | ## Methods diff --git a/packages/calcite-components/src/components/alert/readme.md b/packages/calcite-components/src/components/alert/readme.md index b9345015c29..c42f545ce3c 100644 --- a/packages/calcite-components/src/components/alert/readme.md +++ b/packages/calcite-components/src/components/alert/readme.md @@ -10,7 +10,7 @@ For comprehensive guidance on using and implementing `calcite-alert`, refer to t | -------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ----------- | | `autoClose` | `auto-close` | When `true`, the component closes automatically. Recommended for passive, non-blocking alerts. | `boolean` | `false` | | `autoCloseDuration` | `auto-close-duration` | Specifies the duration before the component automatically closes - only use with `autoClose`. | `"fast" \| "medium" \| "slow"` | `"medium"` | -| `icon` | `icon` | When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon. | `boolean \| IconName` | `undefined` | +| `icon` | `icon` | When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon. | `boolean \| string` | `undefined` | | `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | | `kind` | `kind` | Specifies the kind of the component, which will apply to top border and icon. | `"brand" \| "danger" \| "info" \| "success" \| "warning"` | `"brand"` | | `label` *(required)* | `label` | Specifies an accessible name for the component. | `string` | `undefined` | diff --git a/packages/calcite-components/src/components/block-section/readme.md b/packages/calcite-components/src/components/block-section/readme.md index 2039d8daa41..9df4f6b6195 100644 --- a/packages/calcite-components/src/components/block-section/readme.md +++ b/packages/calcite-components/src/components/block-section/readme.md @@ -6,16 +6,16 @@ For comprehensive guidance on using and implementing `calcite-block-section`, re ## Properties -| Property | Attribute | Description | Type | Default | -| ------------------ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `BlockSectionMessages` | `undefined` | -| `open` | `open` | When `true`, expands the component and its contents. | `boolean` | `false` | -| `status` | `status` | **[DEPRECATED]** Use `icon-start` instead.

Displays a status-related indicator icon. | `"idle" \| "invalid" \| "valid"` | `undefined` | -| `text` | `text` | The component header text. | `string` | `undefined` | -| `toggleDisplay` | `toggle-display` | Specifies how the component's toggle is displayed, where: `"button"` sets the toggle to a selectable header, and `"switch"` sets the toggle to a switch. | `"button" \| "switch"` | `"button"` | +| Property | Attribute | Description | Type | Default | +| ------------------ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ----------- | +| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | +| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `BlockSectionMessages` | `undefined` | +| `open` | `open` | When `true`, expands the component and its contents. | `boolean` | `false` | +| `status` | `status` | **[DEPRECATED]** Use `icon-start` instead.

Displays a status-related indicator icon. | `"idle" \| "invalid" \| "valid"` | `undefined` | +| `text` | `text` | The component header text. | `string` | `undefined` | +| `toggleDisplay` | `toggle-display` | Specifies how the component's toggle is displayed, where: `"button"` sets the toggle to a selectable header, and `"switch"` sets the toggle to a switch. | `"button" \| "switch"` | `"button"` | ## Events diff --git a/packages/calcite-components/src/components/block/readme.md b/packages/calcite-components/src/components/block/readme.md index d1c160ed5bf..a2eaf2c9948 100644 --- a/packages/calcite-components/src/components/block/readme.md +++ b/packages/calcite-components/src/components/block/readme.md @@ -6,22 +6,22 @@ For comprehensive guidance on using and implementing `calcite-block`, refer to t ## Properties -| Property | Attribute | Description | Type | Default | -| ---------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -| `collapsible` | `collapsible` | When `true`, the component is collapsible. | `boolean` | `false` | -| `description` | `description` | A description for the component, which displays below the heading. | `string` | `undefined` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `dragHandle` | `drag-handle` | When `true`, displays a drag handle in the header. | `boolean` | `false` | -| `heading` *(required)* | `heading` | The component header text. | `string` | `undefined` | -| `headingLevel` | `heading-level` | Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling. | `1 \| 2 \| 3 \| 4 \| 5 \| 6` | `undefined` | -| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` | -| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `BlockMessages` | `undefined` | -| `open` | `open` | When `true`, expands the component and its contents. | `boolean` | `false` | -| `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | -| `status` | `status` | **[DEPRECATED]** Use `icon-start` instead.

Displays a status-related indicator icon. | `"idle" \| "invalid" \| "valid"` | `undefined` | +| Property | Attribute | Description | Type | Default | +| ---------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ | +| `collapsible` | `collapsible` | When `true`, the component is collapsible. | `boolean` | `false` | +| `description` | `description` | A description for the component, which displays below the heading. | `string` | `undefined` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `dragHandle` | `drag-handle` | When `true`, displays a drag handle in the header. | `boolean` | `false` | +| `heading` *(required)* | `heading` | The component header text. | `string` | `undefined` | +| `headingLevel` | `heading-level` | Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling. | `1 \| 2 \| 3 \| 4 \| 5 \| 6` | `undefined` | +| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | +| `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` | +| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `BlockMessages` | `undefined` | +| `open` | `open` | When `true`, expands the component and its contents. | `boolean` | `false` | +| `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | +| `status` | `status` | **[DEPRECATED]** Use `icon-start` instead.

Displays a status-related indicator icon. | `"idle" \| "invalid" \| "valid"` | `undefined` | ## Events diff --git a/packages/calcite-components/src/components/button/readme.md b/packages/calcite-components/src/components/button/readme.md index fc62e04e56b..7b108183693 100644 --- a/packages/calcite-components/src/components/button/readme.md +++ b/packages/calcite-components/src/components/button/readme.md @@ -6,29 +6,29 @@ For comprehensive guidance on using and implementing `calcite-button`, refer to ## Properties -| Property | Attribute | Description | Type | Default | -| ------------------ | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `alignment` | `alignment` | Specifies the alignment of the component's elements. | `"center" \| "end" \| "icon-end-space-between" \| "icon-start-space-between" \| "space-between" \| "start"` | `"center"` | -| `appearance` | `appearance` | Specifies the appearance style of the component. | `"outline" \| "outline-fill" \| "solid" \| "transparent"` | `"solid"` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `download` | `download` | Prompts the user to save the linked URL instead of navigating to it. Can be used with or without a value: Without a value, the browser will suggest a filename/extension See . | `boolean \| string` | `false` | -| `form` | `form` | The `id` of the form that will be associated with the component. When not set, the component will be associated with its ancestor form element, if any. | `string` | `undefined` | -| `href` | `href` | Specifies the URL of the linked resource, which can be set as an absolute or relative path. | `string` | `undefined` | -| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `kind` | `kind` | Specifies the kind of the component, which will apply to the border and background if applicable. | `"brand" \| "danger" \| "inverse" \| "neutral"` | `"brand"` | -| `label` | `label` | Accessible name for the component. | `string` | `undefined` | -| `loading` | `loading` | When `true`, a busy indicator is displayed and interaction is disabled. | `boolean` | `false` | -| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ButtonMessages` | `undefined` | -| `name` | `name` | Specifies the name of the component on form submission. | `string` | `undefined` | -| `rel` | `rel` | Defines the relationship between the `href` value and the current document. | `string` | `undefined` | -| `round` | `round` | When `true`, adds a round style to the component. | `boolean` | `false` | -| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | -| `splitChild` | `split-child` | Specifies if the component is a child of a `calcite-split-button`. | `"primary" \| "secondary" \| boolean` | `false` | -| `target` | `target` | Specifies where to open the linked document defined in the `href` property. | `string` | `undefined` | -| `type` | `type` | Specifies the default behavior of the component. | `string` | `"button"` | -| `width` | `width` | Specifies the width of the component. | `"auto" \| "full" \| "half"` | `"auto"` | +| Property | Attribute | Description | Type | Default | +| ------------------ | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------- | +| `alignment` | `alignment` | Specifies the alignment of the component's elements. | `"center" \| "end" \| "icon-end-space-between" \| "icon-start-space-between" \| "space-between" \| "start"` | `"center"` | +| `appearance` | `appearance` | Specifies the appearance style of the component. | `"outline" \| "outline-fill" \| "solid" \| "transparent"` | `"solid"` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `download` | `download` | Prompts the user to save the linked URL instead of navigating to it. Can be used with or without a value: Without a value, the browser will suggest a filename/extension See . | `boolean \| string` | `false` | +| `form` | `form` | The `id` of the form that will be associated with the component. When not set, the component will be associated with its ancestor form element, if any. | `string` | `undefined` | +| `href` | `href` | Specifies the URL of the linked resource, which can be set as an absolute or relative path. | `string` | `undefined` | +| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | +| `kind` | `kind` | Specifies the kind of the component, which will apply to the border and background if applicable. | `"brand" \| "danger" \| "inverse" \| "neutral"` | `"brand"` | +| `label` | `label` | Accessible name for the component. | `string` | `undefined` | +| `loading` | `loading` | When `true`, a busy indicator is displayed and interaction is disabled. | `boolean` | `false` | +| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ButtonMessages` | `undefined` | +| `name` | `name` | Specifies the name of the component on form submission. | `string` | `undefined` | +| `rel` | `rel` | Defines the relationship between the `href` value and the current document. | `string` | `undefined` | +| `round` | `round` | When `true`, adds a round style to the component. | `boolean` | `false` | +| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | +| `splitChild` | `split-child` | Specifies if the component is a child of a `calcite-split-button`. | `"primary" \| "secondary" \| boolean` | `false` | +| `target` | `target` | Specifies where to open the linked document defined in the `href` property. | `string` | `undefined` | +| `type` | `type` | Specifies the default behavior of the component. | `string` | `"button"` | +| `width` | `width` | Specifies the width of the component. | `"auto" \| "full" \| "half"` | `"auto"` | ## Methods diff --git a/packages/calcite-components/src/components/chip/readme.md b/packages/calcite-components/src/components/chip/readme.md index 2f8f6f57ce1..cf7dd42c029 100644 --- a/packages/calcite-components/src/components/chip/readme.md +++ b/packages/calcite-components/src/components/chip/readme.md @@ -6,20 +6,20 @@ For comprehensive guidance on using and implementing `calcite-chip`, refer to th ## Properties -| Property | Attribute | Description | Type | Default | -| -------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `appearance` | `appearance` | Specifies the appearance style of the component. | `"outline" \| "outline-fill" \| "solid"` | `"solid"` | -| `closable` | `closable` | When `true`, a close button is added to the component. | `boolean` | `false` | -| `closed` | `closed` | When `true`, hides the component. | `boolean` | `false` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `icon` | `icon` | Specifies an icon to display. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | -| `kind` | `kind` | Specifies the kind of the component, which will apply to border and background if applicable. | `"brand" \| "inverse" \| "neutral"` | `"neutral"` | -| `label` | `label` | Accessible name for the component. | `string` | `undefined` | -| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ChipMessages` | `undefined` | -| `scale` | `scale` | Specifies the size of the component. When contained in a parent `calcite-chip-group` inherits the parent's `scale` value. | `"l" \| "m" \| "s"` | `"m"` | -| `selected` | `selected` | When `true`, the component is selected. | `boolean` | `false` | -| `value` *(required)* | `value` | The component's value. | `any` | `undefined` | +| Property | Attribute | Description | Type | Default | +| -------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | ----------- | +| `appearance` | `appearance` | Specifies the appearance style of the component. | `"outline" \| "outline-fill" \| "solid"` | `"solid"` | +| `closable` | `closable` | When `true`, a close button is added to the component. | `boolean` | `false` | +| `closed` | `closed` | When `true`, hides the component. | `boolean` | `false` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `icon` | `icon` | Specifies an icon to display. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | +| `kind` | `kind` | Specifies the kind of the component, which will apply to border and background if applicable. | `"brand" \| "inverse" \| "neutral"` | `"neutral"` | +| `label` | `label` | Accessible name for the component. | `string` | `undefined` | +| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ChipMessages` | `undefined` | +| `scale` | `scale` | Specifies the size of the component. When contained in a parent `calcite-chip-group` inherits the parent's `scale` value. | `"l" \| "m" \| "s"` | `"m"` | +| `selected` | `selected` | When `true`, the component is selected. | `boolean` | `false` | +| `value` *(required)* | `value` | The component's value. | `any` | `undefined` | ## Events diff --git a/packages/calcite-components/src/components/combobox-item/readme.md b/packages/calcite-components/src/components/combobox-item/readme.md index b8cb27beec2..a2aec1f1c7a 100644 --- a/packages/calcite-components/src/components/combobox-item/readme.md +++ b/packages/calcite-components/src/components/combobox-item/readme.md @@ -6,21 +6,21 @@ For comprehensive guidance on using and implementing `calcite-combobox-item`, re ## Properties -| Property | Attribute | Description | Type | Default | -| ------------------------ | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `active` | `active` | When `true`, the component is active. | `boolean` | `false` | -| `ancestors` | -- | Specifies the parent and grandparent items, which are set on `calcite-combobox`. | `ComboboxChildElement[]` | `undefined` | -| `description` | `description` | A description for the component, which displays below the label. | `string` | `undefined` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `filterDisabled` | `filter-disabled` | When `true`, omits the component from the `calcite-combobox` filtered search results. | `boolean` | `undefined` | -| `guid` | `guid` | The `id` attribute of the component. When omitted, a globally unique identifier is used. | `string` | `guid()` | -| `icon` | `icon` | Specifies an icon to display. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | -| `metadata` | -- | Provides additional metadata to the component used in filtering. | `{ [x: string]: unknown; }` | `undefined` | -| `selected` | `selected` | When `true`, the component is selected. | `boolean` | `false` | -| `shortHeading` | `short-heading` | The component's short heading. When provided, the short heading will be displayed in the component's selection. It is recommended to use 5 characters or fewer. | `string` | `undefined` | -| `textLabel` *(required)* | `text-label` | The component's text. | `string` | `undefined` | -| `value` *(required)* | `value` | The component's value. | `any` | `undefined` | +| Property | Attribute | Description | Type | Default | +| ------------------------ | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ----------- | +| `active` | `active` | When `true`, the component is active. | `boolean` | `false` | +| `ancestors` | -- | Specifies the parent and grandparent items, which are set on `calcite-combobox`. | `ComboboxChildElement[]` | `undefined` | +| `description` | `description` | A description for the component, which displays below the label. | `string` | `undefined` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `filterDisabled` | `filter-disabled` | When `true`, omits the component from the `calcite-combobox` filtered search results. | `boolean` | `undefined` | +| `guid` | `guid` | The `id` attribute of the component. When omitted, a globally unique identifier is used. | `string` | `guid()` | +| `icon` | `icon` | Specifies an icon to display. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | +| `metadata` | -- | Provides additional metadata to the component used in filtering. | `{ [x: string]: unknown; }` | `undefined` | +| `selected` | `selected` | When `true`, the component is selected. | `boolean` | `false` | +| `shortHeading` | `short-heading` | The component's short heading. When provided, the short heading will be displayed in the component's selection. It is recommended to use 5 characters or fewer. | `string` | `undefined` | +| `textLabel` *(required)* | `text-label` | The component's text. | `string` | `undefined` | +| `value` *(required)* | `value` | The component's value. | `any` | `undefined` | ## Events diff --git a/packages/calcite-components/src/components/combobox/readme.md b/packages/calcite-components/src/components/combobox/readme.md index b624f4c8e10..83c264da4bf 100644 --- a/packages/calcite-components/src/components/combobox/readme.md +++ b/packages/calcite-components/src/components/combobox/readme.md @@ -6,35 +6,35 @@ For comprehensive guidance on using and implementing `calcite-combobox`, refer t ## Properties -| Property | Attribute | Description | Type | Default | -| ------------------------ | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowCustomValues` | `allow-custom-values` | When `true`, allows entry of custom values, which are not in the original set of items. | `boolean` | `undefined` | -| `clearDisabled` | `clear-disabled` | When `true`, the value-clearing will be disabled. | `boolean` | `false` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `filterText` | `filter-text` | Text for the component's filter input field. | `string` | `""` | -| `filteredItems` | -- | Specifies the component's filtered items. | `HTMLCalciteComboboxItemElement[]` | `[]` | -| `flipPlacements` | -- | Defines the available placements that can be used when a flip occurs. | `FlipPlacement[]` | `undefined` | -| `form` | `form` | The `id` of the form that will be associated with the component. When not set, the component will be associated with its ancestor form element, if any. | `string` | `undefined` | -| `label` *(required)* | `label` | Accessible name for the component. | `string` | `undefined` | -| `maxItems` | `max-items` | Specifies the maximum number of `calcite-combobox-item`s (including nested children) to display before displaying a scrollbar. | `number` | `0` | -| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ComboboxMessages` | `undefined` | -| `name` | `name` | Specifies the name of the component. Required to pass the component's `value` on form submission. | `string` | `undefined` | -| `open` | `open` | When `true`, displays and positions the component. | `boolean` | `false` | -| `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | -| `placeholder` | `placeholder` | Specifies the placeholder text for the input. | `string` | `undefined` | -| `placeholderIcon` | `placeholder-icon` | Specifies the placeholder icon for the input. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `placeholderIconFlipRtl` | `placeholder-icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | -| `readOnly` | `read-only` | When `true`, the component's value can be read, but controls are not accessible and the value cannot be modified. | `boolean` | `false` | -| `required` | `required` | When `true`, the component must have a value in order for the form to submit. | `boolean` | `false` | -| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | -| `selectedItems` | -- | Specifies the component's selected items. | `HTMLCalciteComboboxItemElement[]` | `[]` | -| `selectionDisplay` | `selection-display` | When `selectionMode` is `"ancestors"` or `"multiple"`, specifies the display of multiple `calcite-combobox-item` selections, where: `"all"` displays all selections with individual `calcite-chip`s, `"fit"` displays individual `calcite-chip`s that scale to the component's size, including a non-closable `calcite-chip`, which provides the number of additional `calcite-combobox-item` selections not visually displayed, and `"single"` displays one `calcite-chip` with the total number of selections. | `"all" \| "fit" \| "single"` | `"all"` | -| `selectionMode` | `selection-mode` | Specifies the selection mode of the component, where: `"multiple"` allows any number of selections, `"single"` allows only one selection, `"single-persist"` allows one selection and prevents de-selection, and `"ancestors"` allows multiple selections, but shows ancestors of selected items as selected, with only deepest children shown in chips. | `"ancestors" \| "multiple" \| "single" \| "single-persist"` | `"multiple"` | -| `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` | -| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| IconName` | `undefined` | -| `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` | -| `validity` | -- | The current validation state of the component. | `{ valid: boolean; badInput: boolean; customError: boolean; patternMismatch: boolean; rangeOverflow: boolean; rangeUnderflow: boolean; stepMismatch: boolean; tooLong: boolean; tooShort: boolean; typeMismatch: boolean; valueMissing: boolean; }` | `{ valid: false, badInput: false, customError: false, patternMismatch: false, rangeOverflow: false, rangeUnderflow: false, stepMismatch: false, tooLong: false, tooShort: false, typeMismatch: false, valueMissing: false, }` | -| `value` | `value` | The component's value(s) from the selected `calcite-combobox-item`(s). | `string \| string[]` | `null` | +| Property | Attribute | Description | Type | Default | +| ------------------------ | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `allowCustomValues` | `allow-custom-values` | When `true`, allows entry of custom values, which are not in the original set of items. | `boolean` | `undefined` | +| `clearDisabled` | `clear-disabled` | When `true`, the value-clearing will be disabled. | `boolean` | `false` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `filterText` | `filter-text` | Text for the component's filter input field. | `string` | `""` | +| `filteredItems` | -- | Specifies the component's filtered items. | `HTMLCalciteComboboxItemElement[]` | `[]` | +| `flipPlacements` | -- | Defines the available placements that can be used when a flip occurs. | `FlipPlacement[]` | `undefined` | +| `form` | `form` | The `id` of the form that will be associated with the component. When not set, the component will be associated with its ancestor form element, if any. | `string` | `undefined` | +| `label` *(required)* | `label` | Accessible name for the component. | `string` | `undefined` | +| `maxItems` | `max-items` | Specifies the maximum number of `calcite-combobox-item`s (including nested children) to display before displaying a scrollbar. | `number` | `0` | +| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ComboboxMessages` | `undefined` | +| `name` | `name` | Specifies the name of the component. Required to pass the component's `value` on form submission. | `string` | `undefined` | +| `open` | `open` | When `true`, displays and positions the component. | `boolean` | `false` | +| `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | +| `placeholder` | `placeholder` | Specifies the placeholder text for the input. | `string` | `undefined` | +| `placeholderIcon` | `placeholder-icon` | Specifies the placeholder icon for the input. | `string` | `undefined` | +| `placeholderIconFlipRtl` | `placeholder-icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | +| `readOnly` | `read-only` | When `true`, the component's value can be read, but controls are not accessible and the value cannot be modified. | `boolean` | `false` | +| `required` | `required` | When `true`, the component must have a value in order for the form to submit. | `boolean` | `false` | +| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | +| `selectedItems` | -- | Specifies the component's selected items. | `HTMLCalciteComboboxItemElement[]` | `[]` | +| `selectionDisplay` | `selection-display` | When `selectionMode` is `"ancestors"` or `"multiple"`, specifies the display of multiple `calcite-combobox-item` selections, where: `"all"` displays all selections with individual `calcite-chip`s, `"fit"` displays individual `calcite-chip`s that scale to the component's size, including a non-closable `calcite-chip`, which provides the number of additional `calcite-combobox-item` selections not visually displayed, and `"single"` displays one `calcite-chip` with the total number of selections. | `"all" \| "fit" \| "single"` | `"all"` | +| `selectionMode` | `selection-mode` | Specifies the selection mode of the component, where: `"multiple"` allows any number of selections, `"single"` allows only one selection, `"single-persist"` allows one selection and prevents de-selection, and `"ancestors"` allows multiple selections, but shows ancestors of selected items as selected, with only deepest children shown in chips. | `"ancestors" \| "multiple" \| "single" \| "single-persist"` | `"multiple"` | +| `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` | +| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| string` | `undefined` | +| `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` | +| `validity` | -- | The current validation state of the component. | `{ valid: boolean; badInput: boolean; customError: boolean; patternMismatch: boolean; rangeOverflow: boolean; rangeUnderflow: boolean; stepMismatch: boolean; tooLong: boolean; tooShort: boolean; typeMismatch: boolean; valueMissing: boolean; }` | `{ valid: false, badInput: false, customError: false, patternMismatch: false, rangeOverflow: false, rangeUnderflow: false, stepMismatch: false, tooLong: false, tooShort: false, typeMismatch: false, valueMissing: false, }` | +| `value` | `value` | The component's value(s) from the selected `calcite-combobox-item`(s). | `string \| string[]` | `null` | ## Events diff --git a/packages/calcite-components/src/components/dialog/readme.md b/packages/calcite-components/src/components/dialog/readme.md index d5b60ae6a2f..04ef5a5b278 100644 --- a/packages/calcite-components/src/components/dialog/readme.md +++ b/packages/calcite-components/src/components/dialog/readme.md @@ -99,6 +99,7 @@ Type: `Promise` | Name | Description | | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--calcite-dialog-border-color` | Specifies the component's border color. | +| `--calcite-dialog-content-space` | Specifies the padding of the component's content. | | `--calcite-dialog-footer-space` | Specifies the padding of the component's footer. | | `--calcite-dialog-scrim-background-color` | Specifies the background color of the component's scrim. | | `--calcite-dialog-size-x` | Specifies the width of the component, using `px`, `em`, `rem`, `vw`, or `%`. Does not exceed the viewport's width - applies when `placement="cover"` is set. | diff --git a/packages/calcite-components/src/components/dropdown-item/readme.md b/packages/calcite-components/src/components/dropdown-item/readme.md index a420e1dc4be..cc75f3d2d2b 100644 --- a/packages/calcite-components/src/components/dropdown-item/readme.md +++ b/packages/calcite-components/src/components/dropdown-item/readme.md @@ -6,17 +6,17 @@ For comprehensive guidance on using and implementing `calcite-dropdown-item`, re ## Properties -| Property | Attribute | Description | Type | Default | -| ------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `href` | `href` | Specifies the URL of the linked resource, which can be set as an absolute or relative path. Determines if the component will render as an anchor. | `string` | `undefined` | -| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `label` | `label` | Accessible name for the component. | `string` | `undefined` | -| `rel` | `rel` | Specifies the relationship to the linked document defined in `href`. | `string` | `undefined` | -| `selected` | `selected` | When `true`, the component is selected. | `boolean` | `false` | -| `target` | `target` | Specifies the frame or window to open the linked document. | `string` | `undefined` | +| Property | Attribute | Description | Type | Default | +| ------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----------- | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `href` | `href` | Specifies the URL of the linked resource, which can be set as an absolute or relative path. Determines if the component will render as an anchor. | `string` | `undefined` | +| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | +| `label` | `label` | Accessible name for the component. | `string` | `undefined` | +| `rel` | `rel` | Specifies the relationship to the linked document defined in `href`. | `string` | `undefined` | +| `selected` | `selected` | When `true`, the component is selected. | `boolean` | `false` | +| `target` | `target` | Specifies the frame or window to open the linked document. | `string` | `undefined` | ## Events diff --git a/packages/calcite-components/src/components/fab/readme.md b/packages/calcite-components/src/components/fab/readme.md index 4a6b02785ee..cdd36a7833f 100644 --- a/packages/calcite-components/src/components/fab/readme.md +++ b/packages/calcite-components/src/components/fab/readme.md @@ -6,18 +6,18 @@ For comprehensive guidance on using and implementing `calcite-fab`, refer to the ## Properties -| Property | Attribute | Description | Type | Default | -| ------------- | --------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -| `appearance` | `appearance` | Specifies the appearance style of the component. | `"outline-fill" \| "solid"` | `"solid"` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `icon` | `icon` | Specifies an icon to display. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `ICONS.plus` | -| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | -| `kind` | `kind` | Specifies the kind of the component, which will apply to border and background. | `"brand" \| "danger" \| "inverse" \| "neutral"` | `"brand"` | -| `label` | `label` | Accessible name for the component. | `string` | `undefined` | -| `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` | -| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | -| `text` | `text` | Specifies text to accompany the component's icon. | `string` | `undefined` | -| `textEnabled` | `text-enabled` | When `true`, displays the `text` value in the component. | `boolean` | `false` | +| Property | Attribute | Description | Type | Default | +| ------------- | --------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------- | ------------ | +| `appearance` | `appearance` | Specifies the appearance style of the component. | `"outline-fill" \| "solid"` | `"solid"` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `icon` | `icon` | Specifies an icon to display. | `string` | `ICONS.plus` | +| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | +| `kind` | `kind` | Specifies the kind of the component, which will apply to border and background. | `"brand" \| "danger" \| "inverse" \| "neutral"` | `"brand"` | +| `label` | `label` | Accessible name for the component. | `string` | `undefined` | +| `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` | +| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | +| `text` | `text` | Specifies text to accompany the component's icon. | `string` | `undefined` | +| `textEnabled` | `text-enabled` | When `true`, displays the `text` value in the component. | `boolean` | `false` | ## Methods diff --git a/packages/calcite-components/src/components/icon/readme.md b/packages/calcite-components/src/components/icon/readme.md index 3c352237ad9..3e2d71d7bf7 100644 --- a/packages/calcite-components/src/components/icon/readme.md +++ b/packages/calcite-components/src/components/icon/readme.md @@ -6,12 +6,12 @@ For comprehensive guidance on using and implementing `calcite-icon`, refer to th ## Properties -| Property | Attribute | Description | Type | Default | -| ----------- | ------------ | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `flipRtl` | `flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | -| `icon` | `icon` | Displays a specific icon. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `null` | -| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | -| `textLabel` | `text-label` | Accessible name for the component. It is recommended to set this value if your icon is semantic. | `string` | `undefined` | +| Property | Attribute | Description | Type | Default | +| ----------- | ------------ | ------------------------------------------------------------------------------------------------ | ------------------- | ----------- | +| `flipRtl` | `flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | +| `icon` | `icon` | Displays a specific icon. | `string` | `null` | +| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | +| `textLabel` | `text-label` | Accessible name for the component. It is recommended to set this value if your icon is semantic. | `string` | `undefined` | ## CSS Custom Properties diff --git a/packages/calcite-components/src/components/input-date-picker/readme.md b/packages/calcite-components/src/components/input-date-picker/readme.md index 28c58f96207..2343038180f 100644 --- a/packages/calcite-components/src/components/input-date-picker/readme.md +++ b/packages/calcite-components/src/components/input-date-picker/readme.md @@ -30,7 +30,7 @@ For comprehensive guidance on using and implementing `calcite-input-date-picker` | `required` | `required` | When `true`, the component must have a value in order for the form to submit. | `boolean` | `false` | | `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | | `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` | -| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| IconName` | `undefined` | +| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| string` | `undefined` | | `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` | | `validity` | -- | The current validation state of the component. | `{ valid: boolean; badInput: boolean; customError: boolean; patternMismatch: boolean; rangeOverflow: boolean; rangeUnderflow: boolean; stepMismatch: boolean; tooLong: boolean; tooShort: boolean; typeMismatch: boolean; valueMissing: boolean; }` | `{ valid: false, badInput: false, customError: false, patternMismatch: false, rangeOverflow: false, rangeUnderflow: false, stepMismatch: false, tooLong: false, tooShort: false, typeMismatch: false, valueMissing: false, }` | | `value` | `value` | Selected date as a string in ISO format (`"yyyy-mm-dd"`). | `string \| string[]` | `""` | @@ -54,14 +54,16 @@ Updates the position of the component. #### Parameters -| Name | Type | Description | -| --------- | --------- | ----------- | -| `delayed` | `boolean` | | +| Name | Type | Description | +| --------- | --------- | -------------------------------------- | +| `delayed` | `boolean` | If true, the repositioning is delayed. | #### Returns Type: `Promise` +void + ### `setFocus() => Promise` Sets focus on the component. diff --git a/packages/calcite-components/src/components/input-message/readme.md b/packages/calcite-components/src/components/input-message/readme.md index 7847a2a6ab8..bc00c93485e 100644 --- a/packages/calcite-components/src/components/input-message/readme.md +++ b/packages/calcite-components/src/components/input-message/readme.md @@ -8,7 +8,7 @@ For comprehensive guidance on using and implementing `calcite-input-message`, re | Property | Attribute | Description | Type | Default | | ------------- | --------------- | -------------------------------------------------------------------------------------------- | -------------------------------- | ----------- | -| `icon` | `icon` | Specifies an icon to display. | `boolean \| IconName` | `undefined` | +| `icon` | `icon` | Specifies an icon to display. | `boolean \| string` | `undefined` | | `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | | `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | | `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` | diff --git a/packages/calcite-components/src/components/input-number/readme.md b/packages/calcite-components/src/components/input-number/readme.md index d4d028851ab..bc5f19b0b6d 100644 --- a/packages/calcite-components/src/components/input-number/readme.md +++ b/packages/calcite-components/src/components/input-number/readme.md @@ -15,7 +15,7 @@ For comprehensive guidance on using and implementing `calcite-input-number`, ref | `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | | `form` | `form` | The `id` of the form that will be associated with the component. When not set, the component will be associated with its ancestor form element, if any. | `string` | `undefined` | | `groupSeparator` | `group-separator` | When `true`, number values are displayed with a group separator corresponding to the language and country format. | `boolean` | `false` | -| `icon` | `icon` | Specifies an icon to display. | `boolean \| IconName` | `undefined` | +| `icon` | `icon` | Specifies an icon to display. | `boolean \| string` | `undefined` | | `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | | `integer` | `integer` | When `true`, restricts the component to integer numbers only and disables exponential notation. | `boolean` | `false` | | `label` | `label` | Accessible name for the component's button or hyperlink. | `string` | `undefined` | @@ -36,7 +36,7 @@ For comprehensive guidance on using and implementing `calcite-input-number`, ref | `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` | | `step` | `step` | Specifies the granularity that the component's value must adhere to. | `"any" \| number` | `undefined` | | `suffixText` | `suffix-text` | Adds text to the end of the component. | `string` | `undefined` | -| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| IconName` | `undefined` | +| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| string` | `undefined` | | `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` | | `validity` | -- | The current validation state of the component. | `{ valid: boolean; badInput: boolean; customError: boolean; patternMismatch: boolean; rangeOverflow: boolean; rangeUnderflow: boolean; stepMismatch: boolean; tooLong: boolean; tooShort: boolean; typeMismatch: boolean; valueMissing: boolean; }` | `{ valid: false, badInput: false, customError: false, patternMismatch: false, rangeOverflow: false, rangeUnderflow: false, stepMismatch: false, tooLong: false, tooShort: false, typeMismatch: false, valueMissing: false, }` | | `value` | `value` | The component's value. | `string` | `""` | diff --git a/packages/calcite-components/src/components/input-text/readme.md b/packages/calcite-components/src/components/input-text/readme.md index 70aaafea823..e172010ef84 100644 --- a/packages/calcite-components/src/components/input-text/readme.md +++ b/packages/calcite-components/src/components/input-text/readme.md @@ -14,7 +14,7 @@ For comprehensive guidance on using and implementing `calcite-input-text`, refer | `clearable` | `clearable` | When `true`, a clear button is displayed when the component has a value. | `boolean` | `false` | | `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | | `form` | `form` | The `id` of the form that will be associated with the component. When not set, the component will be associated with its ancestor form element, if any. | `string` | `undefined` | -| `icon` | `icon` | Specifies an icon to display. | `boolean \| IconName` | `undefined` | +| `icon` | `icon` | Specifies an icon to display. | `boolean \| string` | `undefined` | | `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | | `label` | `label` | Accessible name for the component's button or hyperlink. | `string` | `undefined` | | `loading` | `loading` | When `true`, the component is in the loading state and `calcite-progress` is displayed. | `boolean` | `false` | @@ -30,7 +30,7 @@ For comprehensive guidance on using and implementing `calcite-input-text`, refer | `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | | `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` | | `suffixText` | `suffix-text` | Adds text to the end of the component. | `string` | `undefined` | -| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| IconName` | `undefined` | +| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| string` | `undefined` | | `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` | | `validity` | -- | The current validation state of the component. | `{ valid: boolean; badInput: boolean; customError: boolean; patternMismatch: boolean; rangeOverflow: boolean; rangeUnderflow: boolean; stepMismatch: boolean; tooLong: boolean; tooShort: boolean; typeMismatch: boolean; valueMissing: boolean; }` | `{ valid: false, badInput: false, customError: false, patternMismatch: false, rangeOverflow: false, rangeUnderflow: false, stepMismatch: false, tooLong: false, tooShort: false, typeMismatch: false, valueMissing: false, }` | | `value` | `value` | The component's value. | `string` | `""` | diff --git a/packages/calcite-components/src/components/input-time-picker/readme.md b/packages/calcite-components/src/components/input-time-picker/readme.md index 9eb48f9a400..167e188ec8f 100644 --- a/packages/calcite-components/src/components/input-time-picker/readme.md +++ b/packages/calcite-components/src/components/input-time-picker/readme.md @@ -18,13 +18,13 @@ For comprehensive guidance on using and implementing `calcite-input-time-picker` | `numberingSystem` | `numbering-system` | Specifies the Unicode numeral system used by the component for localization. | `"arab" \| "arabext" \| "latn"` | `undefined` | | `open` | `open` | When `true`, displays the `calcite-time-picker` component. | `boolean` | `false` | | `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | -| `placement` | `placement` | Determines where the popover will be positioned relative to the input. | `"auto" \| "top" \| "bottom" \| "left" \| "right" \| "top-start" \| "top-end" \| "bottom-start" \| "bottom-end" \| "left-start" \| "left-end" \| "right-start" \| "right-end" \| "leading" \| "trailing" \| "auto-start" \| "auto-end" \| "leading-start" \| "leading-end" \| "trailing-end" \| "trailing-start"` | `"auto"` | +| `placement` | `placement` | Determines where the popover will be positioned relative to the input. | `"auto" \| "top" \| "bottom" \| "right" \| "left" \| "top-start" \| "top-end" \| "bottom-start" \| "bottom-end" \| "right-start" \| "right-end" \| "left-start" \| "left-end" \| "leading" \| "trailing" \| "auto-start" \| "auto-end" \| "leading-start" \| "leading-end" \| "trailing-end" \| "trailing-start"` | `"auto"` | | `readOnly` | `read-only` | When `true`, the component's value can be read, but controls are not accessible and the value cannot be modified. | `boolean` | `false` | | `required` | `required` | When `true`, the component must have a value in order for the form to submit. | `boolean` | `false` | | `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | | `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` | | `step` | `step` | Specifies the granularity the component's `value` must adhere to (in seconds). | `number` | `60` | -| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| IconName` | `undefined` | +| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| string` | `undefined` | | `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` | | `validity` | -- | The current validation state of the component. | `{ valid: boolean; badInput: boolean; customError: boolean; patternMismatch: boolean; rangeOverflow: boolean; rangeUnderflow: boolean; stepMismatch: boolean; tooLong: boolean; tooShort: boolean; typeMismatch: boolean; valueMissing: boolean; }` | `{ valid: false, badInput: false, customError: false, patternMismatch: false, rangeOverflow: false, rangeUnderflow: false, stepMismatch: false, tooLong: false, tooShort: false, typeMismatch: false, valueMissing: false, }` | | `value` | `value` | The time value in ISO (24-hour) format. | `string` | `null` | @@ -47,9 +47,9 @@ Updates the position of the component. #### Parameters -| Name | Type | Description | -| --------- | --------- | ----------- | -| `delayed` | `boolean` | | +| Name | Type | Description | +| --------- | --------- | --------------------------------- | +| `delayed` | `boolean` | If true, delay the repositioning. | #### Returns diff --git a/packages/calcite-components/src/components/input-time-zone/readme.md b/packages/calcite-components/src/components/input-time-zone/readme.md index ca6ed394b1b..4713796bffc 100644 --- a/packages/calcite-components/src/components/input-time-zone/readme.md +++ b/packages/calcite-components/src/components/input-time-zone/readme.md @@ -22,7 +22,7 @@ For comprehensive guidance on using and implementing `calcite-input-time-zone`, | `referenceDate` | `reference-date` | This `date` will be used as a reference to Daylight Savings Time when creating time zone item groups. It can be either a Date instance or a string in ISO format (`"YYYY-MM-DD"`, `"YYYY-MM-DDTHH:MM:SS.SSSZ"`). | `Date \| string` | `undefined` | | `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | | `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` | -| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| IconName` | `undefined` | +| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| string` | `undefined` | | `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` | | `validity` | -- | The current validation state of the component. | `{ valid: boolean; badInput: boolean; customError: boolean; patternMismatch: boolean; rangeOverflow: boolean; rangeUnderflow: boolean; stepMismatch: boolean; tooLong: boolean; tooShort: boolean; typeMismatch: boolean; valueMissing: boolean; }` | `{ valid: false, badInput: false, customError: false, patternMismatch: false, rangeOverflow: false, rangeUnderflow: false, stepMismatch: false, tooLong: false, tooShort: false, typeMismatch: false, valueMissing: false, }` | | `value` | `value` | The component's value, where the value is the time zone offset or the difference, in minutes, between the selected time zone and UTC. If no value is provided, the user's time zone offset will be selected by default. | `string` | `undefined` | diff --git a/packages/calcite-components/src/components/input/readme.md b/packages/calcite-components/src/components/input/readme.md index 24391a14029..e2e660d4cd0 100644 --- a/packages/calcite-components/src/components/input/readme.md +++ b/packages/calcite-components/src/components/input/readme.md @@ -17,7 +17,7 @@ For comprehensive guidance on using and implementing `calcite-input`, refer to t | `files` | -- | When `type` is `"file"`, specifies the component's selected files. | `FileList` | `undefined` | | `form` | `form` | The `id` of the form that will be associated with the component. When not set, the component will be associated with its ancestor form element, if any. | `string` | `undefined` | | `groupSeparator` | `group-separator` | When `true`, number values are displayed with a group separator corresponding to the language and country format. | `boolean` | `false` | -| `icon` | `icon` | When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon. | `boolean \| IconName` | `undefined` | +| `icon` | `icon` | When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon. | `boolean \| string` | `undefined` | | `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | | `label` | `label` | Accessible name for the component. | `string` | `undefined` | | `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` | @@ -40,7 +40,7 @@ For comprehensive guidance on using and implementing `calcite-input`, refer to t | `step` | `step` | Specifies the granularity the component's `value` must adhere to. | `"any" \| number` | `undefined` | | `suffixText` | `suffix-text` | Adds text to the end of the component. | `string` | `undefined` | | `type` | `type` | Specifies the component type. Note that the following `type`s add type-specific icons by default: `"date"`, `"email"`, `"password"`, `"search"`, `"tel"`, `"time"`. | `"color" \| "date" \| "datetime-local" \| "email" \| "file" \| "image" \| "month" \| "number" \| "password" \| "search" \| "tel" \| "text" \| "textarea" \| "time" \| "url" \| "week"` | `"text"` | -| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| IconName` | `undefined` | +| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| string` | `undefined` | | `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` | | `validity` | -- | The current validation state of the component. | `{ valid: boolean; badInput: boolean; customError: boolean; patternMismatch: boolean; rangeOverflow: boolean; rangeUnderflow: boolean; stepMismatch: boolean; tooLong: boolean; tooShort: boolean; typeMismatch: boolean; valueMissing: boolean; }` | `{ valid: false, badInput: false, customError: false, patternMismatch: false, rangeOverflow: false, rangeUnderflow: false, stepMismatch: false, tooLong: false, tooShort: false, typeMismatch: false, valueMissing: false, }` | | `value` | `value` | The component's value. | `string` | `""` | diff --git a/packages/calcite-components/src/components/link/readme.md b/packages/calcite-components/src/components/link/readme.md index fc0cd62c9e3..899a5defa7c 100644 --- a/packages/calcite-components/src/components/link/readme.md +++ b/packages/calcite-components/src/components/link/readme.md @@ -6,16 +6,16 @@ For comprehensive guidance on using and implementing `calcite-link`, refer to th ## Properties -| Property | Attribute | Description | Type | Default | -| ------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `download` | `download` | Prompts the user to save the linked URL instead of navigating to it. Can be used with or without a value: Without a value, the browser will suggest a filename/extension See . | `boolean \| string` | `false` | -| `href` | `href` | Specifies the URL of the linked resource, which can be set as an absolute or relative path. | `string` | `undefined` | -| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `rel` | `rel` | Specifies the relationship to the linked document defined in `href`. | `string` | `undefined` | -| `target` | `target` | Specifies the frame or window to open the linked document. | `string` | `undefined` | +| Property | Attribute | Description | Type | Default | +| ------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----------- | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `download` | `download` | Prompts the user to save the linked URL instead of navigating to it. Can be used with or without a value: Without a value, the browser will suggest a filename/extension See . | `boolean \| string` | `false` | +| `href` | `href` | Specifies the URL of the linked resource, which can be set as an absolute or relative path. | `string` | `undefined` | +| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | +| `rel` | `rel` | Specifies the relationship to the linked document defined in `href`. | `string` | `undefined` | +| `target` | `target` | Specifies the frame or window to open the linked document. | `string` | `undefined` | ## Methods diff --git a/packages/calcite-components/src/components/list-item/list-item.tsx b/packages/calcite-components/src/components/list-item/list-item.tsx index 6d9e924f41e..5aa7f664d0c 100644 --- a/packages/calcite-components/src/components/list-item/list-item.tsx +++ b/packages/calcite-components/src/components/list-item/list-item.tsx @@ -55,7 +55,7 @@ const focusMap = new Map(); const listSelector = "calcite-list"; /** - * @slot - A slot for adding `calcite-list-item` and `calcite-list-item-group` elements. + * @slot - A slot for adding `calcite-list`, `calcite-list-item` and `calcite-list-item-group` elements. * @slot actions-start - A slot for adding actionable `calcite-action` elements before the content of the component. * @slot content-start - A slot for adding non-actionable elements before the label and description of the component. * @slot content - A slot for adding non-actionable, centered content in place of the `label` and `description` of the component. diff --git a/packages/calcite-components/src/components/menu-item/readme.md b/packages/calcite-components/src/components/menu-item/readme.md index d3b13340a9f..681add56717 100644 --- a/packages/calcite-components/src/components/menu-item/readme.md +++ b/packages/calcite-components/src/components/menu-item/readme.md @@ -6,20 +6,20 @@ For comprehensive guidance on using and implementing `calcite-menu-item`, refer ## Properties -| Property | Attribute | Description | Type | Default | -| -------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `active` | `active` | When `true`, the component is highlighted. | `boolean` | `undefined` | -| `breadcrumb` | `breadcrumb` | When `true`, the component displays a breadcrumb trail for use as a navigational aid. | `boolean` | `undefined` | -| `href` | `href` | Specifies the URL destination of the component, which can be set as an absolute or relative path. | `string` | `undefined` | -| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `label` *(required)* | `label` | Accessible name for the component. | `string` | `undefined` | -| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `MenuItemMessages` | `undefined` | -| `open` | `open` | When `true`, the component will display any slotted `calcite-menu-item` in an open overflow menu. | `boolean` | `false` | -| `rel` | `rel` | Defines the relationship between the `href` value and the current document. | `string` | `undefined` | -| `target` | `target` | Specifies where to open the linked document defined in the `href` property. | `string` | `undefined` | -| `text` | `text` | Specifies the text to display. | `string` | `undefined` | +| Property | Attribute | Description | Type | Default | +| -------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------- | ---------------------------- | ----------- | +| `active` | `active` | When `true`, the component is highlighted. | `boolean` | `undefined` | +| `breadcrumb` | `breadcrumb` | When `true`, the component displays a breadcrumb trail for use as a navigational aid. | `boolean` | `undefined` | +| `href` | `href` | Specifies the URL destination of the component, which can be set as an absolute or relative path. | `string` | `undefined` | +| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | +| `label` *(required)* | `label` | Accessible name for the component. | `string` | `undefined` | +| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `MenuItemMessages` | `undefined` | +| `open` | `open` | When `true`, the component will display any slotted `calcite-menu-item` in an open overflow menu. | `boolean` | `false` | +| `rel` | `rel` | Defines the relationship between the `href` value and the current document. | `string` | `undefined` | +| `target` | `target` | Specifies where to open the linked document defined in the `href` property. | `string` | `undefined` | +| `text` | `text` | Specifies the text to display. | `string` | `undefined` | ## Events diff --git a/packages/calcite-components/src/components/modal/modal.tsx b/packages/calcite-components/src/components/modal/modal.tsx index 7b59e903d70..d8833bc94fa 100644 --- a/packages/calcite-components/src/components/modal/modal.tsx +++ b/packages/calcite-components/src/components/modal/modal.tsx @@ -69,7 +69,7 @@ let initialDocumentOverflowStyle: string = ""; logger.deprecated("component", { name: "modal", - removalVersion: 3, + removalVersion: 4, suggested: "dialog", }); diff --git a/packages/calcite-components/src/components/navigation-logo/readme.md b/packages/calcite-components/src/components/navigation-logo/readme.md index f0be053d1fd..4c9738fcd7d 100644 --- a/packages/calcite-components/src/components/navigation-logo/readme.md +++ b/packages/calcite-components/src/components/navigation-logo/readme.md @@ -6,19 +6,19 @@ For comprehensive guidance on using and implementing `calcite-navigation-logo`, ## Properties -| Property | Attribute | Description | Type | Default | -| -------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `active` | `active` | When `true`, the component is highlighted. | `boolean` | `undefined` | -| `description` | `description` | A description for the component, which displays below the `heading`. | `string` | `undefined` | -| `heading` | `heading` | Specifies heading text for the component, such as a product or organization name. | `string` | `undefined` | -| `headingLevel` | `heading-level` | Specifies the heading level of the component's heading for proper document structure, without affecting visual styling. | `1 \| 2 \| 3 \| 4 \| 5 \| 6` | `undefined` | -| `href` | `href` | Specifies the URL destination of the component, which can be set as an absolute or relative path. | `string` | `undefined` | -| `icon` | `icon` | Specifies an icon to display. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | -| `label` | `label` | Describes the appearance or function of the `thumbnail`. If no label is provided, context will not be provided to assistive technologies. | `string` | `undefined` | -| `rel` | `rel` | Defines the relationship between the `href` value and the current document. | `string` | `undefined` | -| `target` | `target` | Specifies where to open the linked document defined in the `href` property. | `string` | `undefined` | -| `thumbnail` | `thumbnail` | Specifies the `src` to an image. | `string` | `undefined` | +| Property | Attribute | Description | Type | Default | +| -------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----------- | +| `active` | `active` | When `true`, the component is highlighted. | `boolean` | `undefined` | +| `description` | `description` | A description for the component, which displays below the `heading`. | `string` | `undefined` | +| `heading` | `heading` | Specifies heading text for the component, such as a product or organization name. | `string` | `undefined` | +| `headingLevel` | `heading-level` | Specifies the heading level of the component's heading for proper document structure, without affecting visual styling. | `1 \| 2 \| 3 \| 4 \| 5 \| 6` | `undefined` | +| `href` | `href` | Specifies the URL destination of the component, which can be set as an absolute or relative path. | `string` | `undefined` | +| `icon` | `icon` | Specifies an icon to display. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | +| `label` | `label` | Describes the appearance or function of the `thumbnail`. If no label is provided, context will not be provided to assistive technologies. | `string` | `undefined` | +| `rel` | `rel` | Defines the relationship between the `href` value and the current document. | `string` | `undefined` | +| `target` | `target` | Specifies where to open the linked document defined in the `href` property. | `string` | `undefined` | +| `thumbnail` | `thumbnail` | Specifies the `src` to an image. | `string` | `undefined` | ## Methods diff --git a/packages/calcite-components/src/components/notice/readme.md b/packages/calcite-components/src/components/notice/readme.md index b0a48e1a598..e7d6fd2fc1e 100644 --- a/packages/calcite-components/src/components/notice/readme.md +++ b/packages/calcite-components/src/components/notice/readme.md @@ -9,7 +9,7 @@ For comprehensive guidance on using and implementing `calcite-notice`, refer to | Property | Attribute | Description | Type | Default | | ------------------ | ------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ----------- | | `closable` | `closable` | When `true`, a close button is added to the component. | `boolean` | `false` | -| `icon` | `icon` | When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon. | `boolean \| IconName` | `undefined` | +| `icon` | `icon` | When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon. | `boolean \| string` | `undefined` | | `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | | `kind` | `kind` | Specifies the kind of the component, which will apply to top border and icon. | `"brand" \| "danger" \| "info" \| "success" \| "warning"` | `"brand"` | | `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `NoticeMessages` | `undefined` | diff --git a/packages/calcite-components/src/components/popover/readme.md b/packages/calcite-components/src/components/popover/readme.md index d8c1fdcf69a..0ea2873e442 100644 --- a/packages/calcite-components/src/components/popover/readme.md +++ b/packages/calcite-components/src/components/popover/readme.md @@ -21,7 +21,7 @@ For comprehensive guidance on using and implementing `calcite-popover`, refer to | `offsetSkidding` | `offset-skidding` | Offsets the position of the component along the `referenceElement`. | `number` | `0` | | `open` | `open` | When `true`, displays and positions the component. | `boolean` | `false` | | `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | -| `placement` | `placement` | Determines where the component will be positioned relative to the `referenceElement`. | `"auto" \| "top" \| "bottom" \| "left" \| "right" \| "top-start" \| "top-end" \| "bottom-start" \| "bottom-end" \| "left-start" \| "left-end" \| "right-start" \| "right-end" \| "leading" \| "trailing" \| "auto-start" \| "auto-end" \| "leading-start" \| "leading-end" \| "trailing-end" \| "trailing-start"` | `defaultPopoverPlacement` | +| `placement` | `placement` | Determines where the component will be positioned relative to the `referenceElement`. | `"auto" \| "top" \| "bottom" \| "right" \| "left" \| "top-start" \| "top-end" \| "bottom-start" \| "bottom-end" \| "right-start" \| "right-end" \| "left-start" \| "left-end" \| "leading" \| "trailing" \| "auto-start" \| "auto-end" \| "leading-start" \| "leading-end" \| "trailing-end" \| "trailing-start"` | `defaultPopoverPlacement` | | `pointerDisabled` | `pointer-disabled` | When `true`, removes the caret pointer. | `boolean` | `false` | | `referenceElement` *(required)* | `reference-element` | The `referenceElement` used to position the component according to its `placement` value. Setting to an `HTMLElement` is preferred so the component does not need to query the DOM. However, a string `id` of the reference element can also be used. | `Element \| VirtualElement \| string` | `undefined` | | `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | diff --git a/packages/calcite-components/src/components/radio-button-group/readme.md b/packages/calcite-components/src/components/radio-button-group/readme.md index b5b03ebad8e..8e3b01e95bb 100644 --- a/packages/calcite-components/src/components/radio-button-group/readme.md +++ b/packages/calcite-components/src/components/radio-button-group/readme.md @@ -15,7 +15,7 @@ For comprehensive guidance on using and implementing `calcite-radio-button-group | `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | | `selectedItem` | -- | Specifies the component's selected item. | `HTMLCalciteRadioButtonElement` | `null` | | `status` | `status` | Specifies the status of the validation message. | `"idle" \| "invalid" \| "valid"` | `"idle"` | -| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| IconName` | `undefined` | +| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| string` | `undefined` | | `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` | ## Events diff --git a/packages/calcite-components/src/components/segmented-control-item/readme.md b/packages/calcite-components/src/components/segmented-control-item/readme.md index 2c15b3a2229..078bef219e8 100644 --- a/packages/calcite-components/src/components/segmented-control-item/readme.md +++ b/packages/calcite-components/src/components/segmented-control-item/readme.md @@ -6,13 +6,13 @@ For comprehensive guidance on using and implementing `calcite-segmented-control- ## Properties -| Property | Attribute | Description | Type | Default | -| ------------- | --------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `checked` | `checked` | When `true`, the component is checked. | `boolean` | `false` | -| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `value` | `value` | The component's value. | `any` | `undefined` | +| Property | Attribute | Description | Type | Default | +| ------------- | --------------- | -------------------------------------------------------------------------------------------- | --------- | ----------- | +| `checked` | `checked` | When `true`, the component is checked. | `boolean` | `false` | +| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | +| `value` | `value` | The component's value. | `any` | `undefined` | ## Dependencies diff --git a/packages/calcite-components/src/components/segmented-control/readme.md b/packages/calcite-components/src/components/segmented-control/readme.md index 49bedc8b9b3..3ddaa48cf20 100644 --- a/packages/calcite-components/src/components/segmented-control/readme.md +++ b/packages/calcite-components/src/components/segmented-control/readme.md @@ -17,7 +17,7 @@ For comprehensive guidance on using and implementing `calcite-segmented-control` | `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | | `selectedItem` | -- | The component's selected item `HTMLElement`. | `HTMLCalciteSegmentedControlItemElement` | `undefined` | | `status` | `status` | Specifies the status of the validation message. | `"idle" \| "invalid" \| "valid"` | `"idle"` | -| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| IconName` | `undefined` | +| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| string` | `undefined` | | `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` | | `validity` | -- | The current validation state of the component. | `{ valid: boolean; badInput: boolean; customError: boolean; patternMismatch: boolean; rangeOverflow: boolean; rangeUnderflow: boolean; stepMismatch: boolean; tooLong: boolean; tooShort: boolean; typeMismatch: boolean; valueMissing: boolean; }` | `{ valid: false, badInput: false, customError: false, patternMismatch: false, rangeOverflow: false, rangeUnderflow: false, stepMismatch: false, tooLong: false, tooShort: false, typeMismatch: false, valueMissing: false, }` | | `value` | `value` | The component's `selectedItem` value. | `string` | `null` | diff --git a/packages/calcite-components/src/components/select/readme.md b/packages/calcite-components/src/components/select/readme.md index 78e6b6eeef3..5113c0252a2 100644 --- a/packages/calcite-components/src/components/select/readme.md +++ b/packages/calcite-components/src/components/select/readme.md @@ -16,7 +16,7 @@ For comprehensive guidance on using and implementing `calcite-select`, refer to | `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | | `selectedOption` | -- | The component's selected option `HTMLElement`. | `HTMLCalciteOptionElement` | `undefined` | | `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` | -| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| IconName` | `undefined` | +| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| string` | `undefined` | | `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` | | `validity` | -- | The current validation state of the component. | `{ valid: boolean; badInput: boolean; customError: boolean; patternMismatch: boolean; rangeOverflow: boolean; rangeUnderflow: boolean; stepMismatch: boolean; tooLong: boolean; tooShort: boolean; typeMismatch: boolean; valueMissing: boolean; }` | `{ valid: false, badInput: false, customError: false, patternMismatch: false, rangeOverflow: false, rangeUnderflow: false, stepMismatch: false, tooLong: false, tooShort: false, typeMismatch: false, valueMissing: false, }` | | `value` | `value` | The component's `selectedOption` value. | `string` | `null` | diff --git a/packages/calcite-components/src/components/shell-panel/readme.md b/packages/calcite-components/src/components/shell-panel/readme.md index cb7585e1492..ff57e7c397c 100644 --- a/packages/calcite-components/src/components/shell-panel/readme.md +++ b/packages/calcite-components/src/components/shell-panel/readme.md @@ -6,18 +6,18 @@ For comprehensive guidance on using and implementing `calcite-shell-panel`, refe ## Properties -| Property | Attribute | Description | Type | Default | -| --------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ | -| `collapsed` | `collapsed` | When `true`, hides the component's content area. | `boolean` | `false` | -| `detached` | `detached` | **[DEPRECATED]** Use `displayMode` instead.

When `true`, the content area displays like a floating panel. | `boolean` | `false` | -| `detachedHeightScale` | `detached-height-scale` | **[DEPRECATED]** Use `heightScale` instead.

When `displayMode` is `float`, specifies the maximum height of the component. | `"l" \| "m" \| "s"` | `undefined` | -| `displayMode` | `display-mode` | Specifies the display mode of the component, where: `"dock"` displays at full height adjacent to center content, `"overlay"` displays at full height on top of center content, and `"float"` does not display at full height with content separately detached from `calcite-action-bar` on top of center content. | `"dock" \| "float" \| "overlay"` | `"dock"` | -| `heightScale` | `height-scale` | When `layout` is `horizontal`, specifies the maximum height of the component. | `"l" \| "m" \| "s"` | `undefined` | -| `layout` | `layout` | The direction of the component. | `"horizontal" \| "vertical"` | `"vertical"` | -| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ShellPanelMessages` | `undefined` | -| `position` | `position` | Specifies the component's position. Will be flipped when the element direction is right-to-left (`"rtl"`). | `"end" \| "start"` | `"start"` | -| `resizable` | `resizable` | When `true` and `displayMode` is not `float`, the component's content area is resizable. | `boolean` | `false` | -| `widthScale` | `width-scale` | When `layout` is `vertical`, specifies the width of the component. | `"l" \| "m" \| "s"` | `"m"` | +| Property | Attribute | Description | Type | Default | +| --------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ------------ | +| `collapsed` | `collapsed` | When `true`, hides the component's content area. | `boolean` | `false` | +| `detached` | `detached` | **[DEPRECATED]** Use `displayMode` instead.

When `true`, the content area displays like a floating panel. | `boolean` | `false` | +| `detachedHeightScale` | `detached-height-scale` | **[DEPRECATED]** Use `heightScale` instead.

When `displayMode` is `float-content` or `float`, specifies the maximum height of the component. | `"l" \| "m" \| "s"` | `undefined` | +| `displayMode` | `display-mode` | Specifies the display mode of the component, where: `"dock"` displays at full height adjacent to center content, `"overlay"` displays at full height on top of center content, and `"float"` [Deprecated] does not display at full height with content separately detached from `calcite-action-bar` on top of center content. `"float-content"` does not display at full height with content separately detached from `calcite-action-bar` on top of center content. `"float-all"` detaches the `calcite-panel` and `calcite-action-bar` on top of center content. | `"dock" \| "float" \| "float-all" \| "float-content" \| "overlay"` | `"dock"` | +| `heightScale` | `height-scale` | When `layout` is `horizontal`, specifies the maximum height of the component. | `"l" \| "m" \| "s"` | `undefined` | +| `layout` | `layout` | The direction of the component. | `"horizontal" \| "vertical"` | `"vertical"` | +| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ShellPanelMessages` | `undefined` | +| `position` | `position` | Specifies the component's position. Will be flipped when the element direction is right-to-left (`"rtl"`). | `"end" \| "start"` | `"start"` | +| `resizable` | `resizable` | When `true` and `displayMode` is not `float-content` or `float`, the component's content area is resizable. | `boolean` | `false` | +| `widthScale` | `width-scale` | When `layout` is `vertical`, specifies the width of the component. | `"l" \| "m" \| "s"` | `"m"` | ## Slots @@ -28,16 +28,16 @@ For comprehensive guidance on using and implementing `calcite-shell-panel`, refe ## CSS Custom Properties -| Name | Description | -| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| `--calcite-shell-panel-detached-max-height` | [Deprecated] Use the `heightScale` property instead. When `displayMode` is `float`, specifies the maximum height of the component. | -| `--calcite-shell-panel-height` | When `layout` is `horizontal`, or `layout` is `vertical` and `displayMode` is `float`, specifies the height of the component. | -| `--calcite-shell-panel-max-height` | When `layout` is `horizontal`, or `layout` is `vertical` and `displayMode` is `float`, specifies the maximum height of the component. | -| `--calcite-shell-panel-max-width` | Specifies the maximum width of the component. | -| `--calcite-shell-panel-min-height` | When `layout` is `horizontal`, or `layout` is `vertical` and `displayMode` is `float`, specifies the minimum height of the component. | -| `--calcite-shell-panel-min-width` | Specifies the minimum width of the component. | -| `--calcite-shell-panel-width` | Specifies the width of the component. | -| `--calcite-shell-panel-z-index` | Specifies the z-index value for the component. | +| Name | Description | +| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--calcite-shell-panel-detached-max-height` | [Deprecated] Use the `heightScale` property instead. When `displayMode` is `float-content` or `float`, specifies the maximum height of the component. | +| `--calcite-shell-panel-height` | When `layout` is `horizontal`, or `layout` is `vertical` and `displayMode` is `float-content` or `float`, specifies the height of the component. | +| `--calcite-shell-panel-max-height` | When `layout` is `horizontal`, or `layout` is `vertical` and `displayMode` is `float-content` or `float`, specifies the maximum height of the component. | +| `--calcite-shell-panel-max-width` | Specifies the maximum width of the component. | +| `--calcite-shell-panel-min-height` | When `layout` is `horizontal`, or `layout` is `vertical` and `displayMode` is `float-content` or `float`, specifies the minimum height of the component. | +| `--calcite-shell-panel-min-width` | Specifies the minimum width of the component. | +| `--calcite-shell-panel-width` | Specifies the width of the component. | +| `--calcite-shell-panel-z-index` | Specifies the z-index value for the component. | --- diff --git a/packages/calcite-components/src/components/split-button/readme.md b/packages/calcite-components/src/components/split-button/readme.md index 07a30731b40..5e51d9b6f5b 100644 --- a/packages/calcite-components/src/components/split-button/readme.md +++ b/packages/calcite-components/src/components/split-button/readme.md @@ -6,24 +6,24 @@ For comprehensive guidance on using and implementing `calcite-split-button`, ref ## Properties -| Property | Attribute | Description | Type | Default | -| -------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | -| `appearance` | `appearance` | Specifies the appearance style of the component. | `"outline" \| "outline-fill" \| "solid" \| "transparent"` | `"solid"` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `dropdownIconType` | `dropdown-icon-type` | Specifies the icon used for the dropdown menu. | `"caret" \| "chevron" \| "ellipsis" \| "overflow"` | `"chevron"` | -| `dropdownLabel` | `dropdown-label` | Accessible name for the dropdown menu. | `string` | `undefined` | -| `flipPlacements` | -- | Defines the available placements that can be used when a flip occurs. | `FlipPlacement[]` | `undefined` | -| `kind` | `kind` | Specifies the kind of the component, which will apply to border and background, if applicable. | `"brand" \| "danger" \| "inverse" \| "neutral"` | `"brand"` | -| `loading` | `loading` | When `true`, a busy indicator is displayed on the primary button. | `boolean` | `false` | -| `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | -| `placement` | `placement` | Determines where the component will be positioned relative to the container element. | `"bottom" \| "bottom-end" \| "bottom-start" \| "top" \| "top-end" \| "top-start"` | `"bottom-end"` | -| `primaryIconEnd` | `primary-icon-end` | Specifies an icon to display at the end of the primary button. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `primaryIconFlipRtl` | `primary-icon-flip-rtl` | Displays the `primaryIconStart` and/or `primaryIconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `primaryIconStart` | `primary-icon-start` | Specifies an icon to display at the start of the primary button. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `primaryLabel` | `primary-label` | Accessible name for the primary button. | `string` | `undefined` | -| `primaryText` | `primary-text` | Text displayed in the primary button. | `string` | `undefined` | -| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | -| `width` | `width` | Specifies the width of the component. | `"auto" \| "full" \| "half"` | `"auto"` | +| Property | Attribute | Description | Type | Default | +| -------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -------------- | +| `appearance` | `appearance` | Specifies the appearance style of the component. | `"outline" \| "outline-fill" \| "solid" \| "transparent"` | `"solid"` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `dropdownIconType` | `dropdown-icon-type` | Specifies the icon used for the dropdown menu. | `"caret" \| "chevron" \| "ellipsis" \| "overflow"` | `"chevron"` | +| `dropdownLabel` | `dropdown-label` | Accessible name for the dropdown menu. | `string` | `undefined` | +| `flipPlacements` | -- | Defines the available placements that can be used when a flip occurs. | `FlipPlacement[]` | `undefined` | +| `kind` | `kind` | Specifies the kind of the component, which will apply to border and background, if applicable. | `"brand" \| "danger" \| "inverse" \| "neutral"` | `"brand"` | +| `loading` | `loading` | When `true`, a busy indicator is displayed on the primary button. | `boolean` | `false` | +| `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | +| `placement` | `placement` | Determines where the component will be positioned relative to the container element. | `"bottom" \| "bottom-end" \| "bottom-start" \| "top" \| "top-end" \| "top-start"` | `"bottom-end"` | +| `primaryIconEnd` | `primary-icon-end` | Specifies an icon to display at the end of the primary button. | `string` | `undefined` | +| `primaryIconFlipRtl` | `primary-icon-flip-rtl` | Displays the `primaryIconStart` and/or `primaryIconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `primaryIconStart` | `primary-icon-start` | Specifies an icon to display at the start of the primary button. | `string` | `undefined` | +| `primaryLabel` | `primary-label` | Accessible name for the primary button. | `string` | `undefined` | +| `primaryText` | `primary-text` | Text displayed in the primary button. | `string` | `undefined` | +| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | +| `width` | `width` | Specifies the width of the component. | `"auto" \| "full" \| "half"` | `"auto"` | ## Events diff --git a/packages/calcite-components/src/components/tab-title/readme.md b/packages/calcite-components/src/components/tab-title/readme.md index 3070b794d2c..555bf5ee109 100644 --- a/packages/calcite-components/src/components/tab-title/readme.md +++ b/packages/calcite-components/src/components/tab-title/readme.md @@ -6,17 +6,17 @@ For comprehensive guidance on using and implementing `calcite-tab-title`, refer ## Properties -| Property | Attribute | Description | Type | Default | -| ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `closable` | `closable` | When `true`, a close button is added to the component. | `boolean` | `false` | -| `closed` | `closed` | When `true`, does not display or position the component. | `boolean` | `false` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `TabTitleMessages` | `undefined` | -| `selected` | `selected` | When `true`, the component and its respective `calcite-tab` contents are selected. Only one tab can be selected within the `calcite-tabs` parent. | `boolean` | `false` | -| `tab` | `tab` | Specifies a unique name for the component. When specified, use the same value on the `calcite-tab`. | `string` | `undefined` | +| Property | Attribute | Description | Type | Default | +| ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----------- | +| `closable` | `closable` | When `true`, a close button is added to the component. | `boolean` | `false` | +| `closed` | `closed` | When `true`, does not display or position the component. | `boolean` | `false` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | +| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `TabTitleMessages` | `undefined` | +| `selected` | `selected` | When `true`, the component and its respective `calcite-tab` contents are selected. Only one tab can be selected within the `calcite-tabs` parent. | `boolean` | `false` | +| `tab` | `tab` | Specifies a unique name for the component. When specified, use the same value on the `calcite-tab`. | `string` | `undefined` | ## Events diff --git a/packages/calcite-components/src/components/text-area/readme.md b/packages/calcite-components/src/components/text-area/readme.md index d91073be823..cba08d50f08 100644 --- a/packages/calcite-components/src/components/text-area/readme.md +++ b/packages/calcite-components/src/components/text-area/readme.md @@ -25,7 +25,7 @@ For comprehensive guidance on using and implementing `calcite-text-area`, refer | `rows` | `rows` | Specifies the component's number of rows. | `number` | `undefined` | | `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | | `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` | -| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| IconName` | `undefined` | +| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| string` | `undefined` | | `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` | | `validity` | -- | The current validation state of the component. | `{ valid: boolean; badInput: boolean; customError: boolean; patternMismatch: boolean; rangeOverflow: boolean; rangeUnderflow: boolean; stepMismatch: boolean; tooLong: boolean; tooShort: boolean; typeMismatch: boolean; valueMissing: boolean; }` | `{ valid: false, badInput: false, customError: false, patternMismatch: false, rangeOverflow: false, rangeUnderflow: false, stepMismatch: false, tooLong: false, tooShort: false, typeMismatch: false, valueMissing: false, }` | | `value` | `value` | The component's value. | `string` | `""` | diff --git a/packages/calcite-components/src/components/tile-select/readme.md b/packages/calcite-components/src/components/tile-select/readme.md index e2067c5b9da..475853943a6 100644 --- a/packages/calcite-components/src/components/tile-select/readme.md +++ b/packages/calcite-components/src/components/tile-select/readme.md @@ -8,20 +8,20 @@ For comprehensive guidance on using and implementing `calcite-tile-select`, refe ## Properties -| Property | Attribute | Description | Type | Default | -| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `checked` | `checked` | When `true`, the component is checked. | `boolean` | `false` | -| `description` | `description` | A description for the component, which displays below the heading. | `string` | `undefined` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `heading` | `heading` | The component header text, which displays between the icon and description. | `string` | `undefined` | -| `icon` | `icon` | Specifies an icon to display. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | -| `inputAlignment` | `input-alignment` | When `inputEnabled` is `true`, specifies the placement of the interactive input on the component. | `"end" \| "start"` | `"start"` | -| `inputEnabled` | `input-enabled` | When `true`, displays an interactive input based on the `type` property. | `boolean` | `false` | -| `name` | `name` | Specifies the name of the component on form submission. | `any` | `undefined` | -| `type` | `type` | Specifies the selection mode of the component, where: `"radio"` is for single selection, and `"checkbox"` is for multiple selections. | `"checkbox" \| "radio"` | `"radio"` | -| `value` | `value` | The component's value. | `any` | `undefined` | -| `width` | `width` | Specifies the width of the component. | `"auto" \| "full"` | `"auto"` | +| Property | Attribute | Description | Type | Default | +| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ----------- | +| `checked` | `checked` | When `true`, the component is checked. | `boolean` | `false` | +| `description` | `description` | A description for the component, which displays below the heading. | `string` | `undefined` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `heading` | `heading` | The component header text, which displays between the icon and description. | `string` | `undefined` | +| `icon` | `icon` | Specifies an icon to display. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | +| `inputAlignment` | `input-alignment` | When `inputEnabled` is `true`, specifies the placement of the interactive input on the component. | `"end" \| "start"` | `"start"` | +| `inputEnabled` | `input-enabled` | When `true`, displays an interactive input based on the `type` property. | `boolean` | `false` | +| `name` | `name` | Specifies the name of the component on form submission. | `any` | `undefined` | +| `type` | `type` | Specifies the selection mode of the component, where: `"radio"` is for single selection, and `"checkbox"` is for multiple selections. | `"checkbox" \| "radio"` | `"radio"` | +| `value` | `value` | The component's value. | `any` | `undefined` | +| `width` | `width` | Specifies the width of the component. | `"auto" \| "full"` | `"auto"` | ## Events diff --git a/packages/calcite-components/src/components/tile/readme.md b/packages/calcite-components/src/components/tile/readme.md index caf9377870a..1b17744fd5b 100644 --- a/packages/calcite-components/src/components/tile/readme.md +++ b/packages/calcite-components/src/components/tile/readme.md @@ -6,20 +6,20 @@ For comprehensive guidance on using and implementing `calcite-tile`, refer to th ## Properties -| Property | Attribute | Description | Type | Default | -| ------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `active` | `active` | **[DEPRECATED]**

When `true`, the component is active. | `boolean` | `false` | -| `alignment` | `alignment` | Specifies the alignment of the Tile's content. | `"center" \| "start"` | `"start"` | -| `description` | `description` | A description for the component, which displays below the heading. | `string` | `undefined` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `embed` | `embed` | **[DEPRECATED]** No longer necessary.

The component's embed mode. When `true`, renders without a border and padding for use by other components. | `boolean` | `false` | -| `heading` | `heading` | The component header text, which displays between the icon and description. | `string` | `undefined` | -| `href` | `href` | When embed is `"false"`, the URL for the component. | `string` | `undefined` | -| `icon` | `icon` | Specifies an icon to display. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | -| `label` | `label` | Accessible name for the component. | `string` | `undefined` | -| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | -| `selected` | `selected` | When `true` and the parent's `selectionMode` is `"single"`, `"single-persist"', or`"multiple"`, the component is selected. | `boolean` | `false` | +| Property | Attribute | Description | Type | Default | +| ------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | ----------- | +| `active` | `active` | **[DEPRECATED]**

When `true`, the component is active. | `boolean` | `false` | +| `alignment` | `alignment` | Specifies the alignment of the Tile's content. | `"center" \| "start"` | `"start"` | +| `description` | `description` | A description for the component, which displays below the heading. | `string` | `undefined` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `embed` | `embed` | **[DEPRECATED]** No longer necessary.

The component's embed mode. When `true`, renders without a border and padding for use by other components. | `boolean` | `false` | +| `heading` | `heading` | The component header text, which displays between the icon and description. | `string` | `undefined` | +| `href` | `href` | When embed is `"false"`, the URL for the component. | `string` | `undefined` | +| `icon` | `icon` | Specifies an icon to display. | `string` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | +| `label` | `label` | Accessible name for the component. | `string` | `undefined` | +| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | +| `selected` | `selected` | When `true` and the parent's `selectionMode` is `"single"`, `"single-persist"', or`"multiple"`, the component is selected. | `boolean` | `false` | ## Events diff --git a/packages/calcite-components/src/components/tooltip/readme.md b/packages/calcite-components/src/components/tooltip/readme.md index 470aefab5d9..65abe3a5ed4 100644 --- a/packages/calcite-components/src/components/tooltip/readme.md +++ b/packages/calcite-components/src/components/tooltip/readme.md @@ -14,7 +14,7 @@ For comprehensive guidance on using and implementing `calcite-tooltip`, refer to | `offsetSkidding` | `offset-skidding` | Offset the position of the component along the `referenceElement`. | `number` | `0` | | `open` | `open` | When `true`, the component is open. | `boolean` | `false` | | `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. The `"fixed"` value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | -| `placement` | `placement` | Determines where the component will be positioned relative to the `referenceElement`. | `"auto" \| "top" \| "bottom" \| "left" \| "right" \| "top-start" \| "top-end" \| "bottom-start" \| "bottom-end" \| "left-start" \| "left-end" \| "right-start" \| "right-end" \| "leading" \| "trailing" \| "auto-start" \| "auto-end" \| "leading-start" \| "leading-end" \| "trailing-end" \| "trailing-start"` | `"auto"` | +| `placement` | `placement` | Determines where the component will be positioned relative to the `referenceElement`. | `"auto" \| "top" \| "bottom" \| "right" \| "left" \| "top-start" \| "top-end" \| "bottom-start" \| "bottom-end" \| "right-start" \| "right-end" \| "left-start" \| "left-end" \| "leading" \| "trailing" \| "auto-start" \| "auto-end" \| "leading-start" \| "leading-end" \| "trailing-end" \| "trailing-start"` | `"auto"` | | `referenceElement` | `reference-element` | The `referenceElement` to position the component according to its `"placement"` value. Setting to the `HTMLElement` is preferred so the component does not need to query the DOM for the `referenceElement`. However, a string ID of the reference element can be used. | `Element \| VirtualElement \| string` | `undefined` | ## Events diff --git a/packages/calcite-components/src/components/tooltip/tooltip.e2e.ts b/packages/calcite-components/src/components/tooltip/tooltip.e2e.ts index a26d919bd90..2953cd23fcf 100644 --- a/packages/calcite-components/src/components/tooltip/tooltip.e2e.ts +++ b/packages/calcite-components/src/components/tooltip/tooltip.e2e.ts @@ -11,11 +11,58 @@ interface PointerMoveOptions { value: boolean; } +const eventOptions = { bubbles: true, cancelable: true }; + describe("calcite-tooltip", () => { type CanceledEscapeKeyPressTestWindow = GlobalTestProps<{ escapeKeyCanceled: boolean; }>; + async function dispatchPointerEvent(page: E2EPage, selector: string): Promise { + await page.$eval( + selector, + (el: HTMLElement, eventOptions) => { + el.dispatchEvent(new PointerEvent("pointermove", eventOptions)); + }, + eventOptions, + ); + await page.waitForChanges(); + } + + async function dispatchClickEvent(page: E2EPage, selector: string): Promise { + await page.$eval( + selector, + (el: HTMLElement, eventOptions) => { + el.dispatchEvent(new MouseEvent("click", eventOptions)); + }, + eventOptions, + ); + await page.waitForChanges(); + } + + async function dispatchDocumentKeydownEvent(page: E2EPage, key: string): Promise { + await page.evaluate( + (eventOptions, key) => { + document.dispatchEvent(new KeyboardEvent("keydown", { key, ...eventOptions })); + }, + eventOptions, + key, + ); + await page.waitForChanges(); + } + + async function dispatchKeydownEvent(page: E2EPage, selector: string, key: string): Promise { + await page.$eval( + selector, + (el: HTMLElement, eventOptions, key) => { + el.dispatchEvent(new KeyboardEvent("keydown", { key, ...eventOptions })); + }, + eventOptions, + key, + ); + await page.waitForChanges(); + } + /** * Helps assert the canceled Esc key press when closing tooltips * Must be called before the tooltip is closed via keyboard. @@ -24,7 +71,8 @@ describe("calcite-tooltip", () => { */ async function setUpEscapeKeyCancelListener(page: E2EPage): Promise { await page.evaluate(() => { - document.addEventListener( + (window as CanceledEscapeKeyPressTestWindow).escapeKeyCanceled = false; + window.addEventListener( "keydown", (event) => { (window as CanceledEscapeKeyPressTestWindow).escapeKeyCanceled = event.defaultPrevented; @@ -386,42 +434,15 @@ describe("calcite-tooltip", () => { expect(await tooltip.getProperty("open")).toBe(false); - await page.evaluate(() => { - const ref = document.getElementById("ref"); - const event1 = new MouseEvent("click", { - cancelable: true, - bubbles: true, - }); - ref.dispatchEvent(event1); - }); - - await page.waitForChanges(); + await dispatchClickEvent(page, "#ref"); expect(await tooltip.getProperty("open")).toBe(true); - await page.evaluate(() => { - const ref = document.getElementById("ref"); - const event1 = new MouseEvent("click", { - cancelable: true, - bubbles: true, - }); - ref.dispatchEvent(event1); - }); - - await page.waitForChanges(); + await dispatchClickEvent(page, "#ref"); expect(await tooltip.getProperty("open")).toBe(true); - await page.evaluate(() => { - const ref = document.getElementById("test"); - const event1 = new MouseEvent("click", { - cancelable: true, - bubbles: true, - }); - ref.dispatchEvent(event1); - }); - - await page.waitForChanges(); + await dispatchClickEvent(page, "#test"); expect(await tooltip.getProperty("open")).toBe(false); }); @@ -449,9 +470,8 @@ describe("calcite-tooltip", () => { expect(await tooltip.getProperty("open")).toBe(true); await setUpEscapeKeyCancelListener(page); - await referenceElement.press("Escape"); - await page.waitForChanges(); + await dispatchKeydownEvent(page, "#ref", "Escape"); expect(await tooltip.getProperty("open")).toBe(false); await assertEscapeKeyCanceled(page, true); @@ -482,9 +502,7 @@ describe("calcite-tooltip", () => { expect(await tooltip.getProperty("open")).toBe(true); await setUpEscapeKeyCancelListener(page); - await page.keyboard.press("Escape"); - - await page.waitForChanges(); + await dispatchDocumentKeydownEvent(page, "Escape"); expect(await tooltip.getProperty("open")).toBe(false); await assertEscapeKeyCanceled(page, false); @@ -517,7 +535,8 @@ describe("calcite-tooltip", () => { expect(await tooltip.getProperty("open")).toBe(true); await setUpEscapeKeyCancelListener(page); - await page.keyboard.press("Escape"); + + await dispatchKeydownEvent(page, "#ref", "Escape"); await page.waitForChanges(); @@ -545,14 +564,9 @@ describe("calcite-tooltip", () => { expect(await hoverTip.getProperty("open")).toBe(false); - await page.$eval("#hoverRef", (el: HTMLElement) => { - el.dispatchEvent(new PointerEvent("pointermove")); - }); - + await dispatchPointerEvent(page, "#hoverRef"); await page.waitForTimeout(TOOLTIP_OPEN_DELAY_MS); - await page.waitForChanges(); - expect(await focusTip.getProperty("open")).toBe(false); expect(await hoverTip.getProperty("open")).toBe(true); @@ -601,14 +615,9 @@ describe("calcite-tooltip", () => { expect(await hoverTip.getProperty("open")).toBe(false); - await page.$eval("#hoverRef", (el: HTMLElement) => { - el.dispatchEvent(new PointerEvent("pointermove")); - }); - + await dispatchPointerEvent(page, "#hoverRef"); await page.waitForTimeout(TOOLTIP_OPEN_DELAY_MS); - await page.waitForChanges(); - expect(await focusTip.getProperty("open")).toBe(false); expect(await hoverTip.getProperty("open")).toBe(true); @@ -940,10 +949,7 @@ describe("calcite-tooltip", () => { for (let i = 0; i < pointerMoves.length; i++) { const { delay, selector } = pointerMoves[i]; await page.waitForTimeout(delay); - await page.$eval(selector, (el: HTMLElement) => { - el.dispatchEvent(new PointerEvent("pointermove")); - }); - + await dispatchPointerEvent(page, selector); expect(await tooltip.getProperty(pointerMoves[i].property)).toBe(pointerMoves[i].value); } }); @@ -999,10 +1005,7 @@ describe("calcite-tooltip", () => { for (let i = 0; i < pointerMoves.length; i++) { const { delay, selector } = pointerMoves[i]; await page.waitForTimeout(delay); - await page.$eval(selector, (el: HTMLElement) => { - el.dispatchEvent(new PointerEvent("pointermove")); - }); - + await dispatchPointerEvent(page, selector); expect(await tooltip.getProperty(pointerMoves[i].property)).toBe(pointerMoves[i].value); } }); @@ -1039,36 +1042,61 @@ describe("calcite-tooltip", () => { ); } - document.body.innerHTML = ""; + document.body.innerHTML = ` + `; }); await page.waitForChanges(); } - function isTooltipOpen(page: E2EPage): Promise { - return page.evaluate((): boolean => { + function isTooltipOpen(page: E2EPage, componentId = "one"): Promise { + return page.evaluate((componentId): boolean => { return document - .querySelector("shadow-component-b") + .querySelector(`#${componentId}`) .shadowRoot.querySelector("shadow-component-a") .shadowRoot.querySelector("calcite-tooltip").open; - }); + }, componentId); } - async function focusReferenceElement(page: E2EPage): Promise { - await page.evaluate((): void => { - const referenceElement = document - .querySelector("shadow-component-b") - .shadowRoot.querySelector("shadow-component-a") - .shadowRoot.querySelector("button"); - referenceElement.dispatchEvent(new FocusEvent("focusin")); - }); + async function focusReferenceElement(page: E2EPage, componentId = "one"): Promise { + await page.$eval( + `#${componentId} >>> shadow-component-a >>> button`, + (refEl, eventOptions) => { + refEl.dispatchEvent(new FocusEvent("focusin", eventOptions)); + }, + eventOptions, + ); } it("should open focused tooltips within shadowRoots", async () => { const page = await newE2EPage(); await defineTestComponents(page); - expect(await isTooltipOpen(page)).toBe(false); - await focusReferenceElement(page); - expect(await isTooltipOpen(page)).toBe(true); + expect(await isTooltipOpen(page, "one")).toBe(false); + expect(await isTooltipOpen(page, "two")).toBe(false); + await focusReferenceElement(page, "one"); + expect(await isTooltipOpen(page, "one")).toBe(true); + expect(await isTooltipOpen(page, "two")).toBe(false); + await focusReferenceElement(page, "two"); + expect(await isTooltipOpen(page, "one")).toBe(false); + expect(await isTooltipOpen(page, "two")).toBe(true); + }); + + it("should open focused tooltips within shadowRoots using tab", async () => { + const page = await newE2EPage(); + await defineTestComponents(page); + expect(await isTooltipOpen(page, "one")).toBe(false); + expect(await isTooltipOpen(page, "two")).toBe(false); + await page.keyboard.press("Tab"); + await page.waitForChanges(); + expect(await isTooltipOpen(page, "one")).toBe(true); + expect(await isTooltipOpen(page, "two")).toBe(false); + await page.keyboard.press("Tab"); + await page.waitForChanges(); + expect(await isTooltipOpen(page, "one")).toBe(false); + expect(await isTooltipOpen(page, "two")).toBe(true); + await page.keyboard.press("Tab"); + await page.waitForChanges(); + expect(await isTooltipOpen(page, "one")).toBe(false); + expect(await isTooltipOpen(page, "two")).toBe(false); }); }); @@ -1090,21 +1118,13 @@ describe("calcite-tooltip", () => { expect(await tooltip1.getProperty("open")).toBe(false); expect(await tooltip2.getProperty("open")).toBe(false); - await page.$eval("#ref1", (el: HTMLElement) => { - el.dispatchEvent(new PointerEvent("pointermove")); - }); + await dispatchPointerEvent(page, "#ref1"); await page.waitForTimeout(TOOLTIP_OPEN_DELAY_MS); - await page.waitForChanges(); - expect(await tooltip1.getProperty("open")).toBe(true); expect(await tooltip2.getProperty("open")).toBe(false); - await page.$eval("#ref2", (el: HTMLElement) => { - el.dispatchEvent(new PointerEvent("pointermove")); - }); + await dispatchPointerEvent(page, "#ref2"); await page.waitForTimeout(0); - await page.waitForChanges(); - expect(await tooltip1.getProperty("open")).toBe(false); expect(await tooltip2.getProperty("open")).toBe(true); }); @@ -1131,10 +1151,7 @@ describe("calcite-tooltip", () => { await page.waitForChanges(); expect(await tooltip.getProperty("open")).toBe(true); - await page.$eval("#other", (el: HTMLElement) => { - el.dispatchEvent(new MouseEvent("click", { cancelable: true, bubbles: true })); - }); - await page.waitForChanges(); + await dispatchClickEvent(page, "#other"); expect(await tooltip.getProperty("open")).toBe(false); }); diff --git a/packages/calcite-components/src/components/tree-item/readme.md b/packages/calcite-components/src/components/tree-item/readme.md index 299bc8c79ad..d613e267d98 100644 --- a/packages/calcite-components/src/components/tree-item/readme.md +++ b/packages/calcite-components/src/components/tree-item/readme.md @@ -6,13 +6,13 @@ For comprehensive guidance on using and implementing `calcite-tree-item`, refer ## Properties -| Property | Attribute | Description | Type | Default | -| ------------- | --------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` | -| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "a3-landscape" \| "a3-portrait" \| "a4-landscape" \| "a4-portrait" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "ansi-a-landscape" \| "ansi-a-portrait" \| "ansi-b-landscape" \| "ansi-b-portrait" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-data-store" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-inset-large" \| "circle-inset-medium" \| "circle-inset-small" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "cloud-data" \| "cloud-server" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "custom-print" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "diamond-inset-large" \| "diamond-inset-medium" \| "diamond-inset-small" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exclamation-point" \| "exclamation-point-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hexagon2-inset-large" \| "hexagon2-inset-medium" \| "hexagon2-inset-small" \| "hexagon-inset-large" \| "hexagon-inset-medium" \| "hexagon-inset-small" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-data-store" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "objectstore-data-store" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "overwrite-project" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relational-data-store" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "spatiotemporal-data-store" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "square-inset-large" \| "square-inset-medium" \| "square-inset-small" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-cache-data-store" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | -| `selected` | `selected` | When `true`, the component is selected. | `boolean` | `false` | +| Property | Attribute | Description | Type | Default | +| ------------- | --------------- | -------------------------------------------------------------------------------------------- | ---------------------------- | ----------- | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` | +| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | +| `selected` | `selected` | When `true`, the component is selected. | `boolean` | `false` | ## Slots diff --git a/packages/calcite-ui-icons/CHANGELOG.md b/packages/calcite-ui-icons/CHANGELOG.md index ec787498053..d0dca9f118d 100644 --- a/packages/calcite-ui-icons/CHANGELOG.md +++ b/packages/calcite-ui-icons/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [3.30.0](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-ui-icons-v3.29.0...@esri/calcite-ui-icons@3.30.0) (2024-07-31) + +### Miscellaneous Chores + +- Add calcite-ui-icons to monorepo ([#9835](https://github.com/Esri/calcite-design-system/issues/9835)) ([05264ea](https://github.com/Esri/calcite-design-system/commit/05264ea84d1c0d88d2878c33434a4166f2f5f532)) + ## 3.29.1-next.0 (2024-07-30) ### Miscellaneous Chores diff --git a/packages/calcite-ui-icons/package.json b/packages/calcite-ui-icons/package.json index 0d8fbbc3d94..abe20a6793f 100644 --- a/packages/calcite-ui-icons/package.json +++ b/packages/calcite-ui-icons/package.json @@ -1,6 +1,6 @@ { "name": "@esri/calcite-ui-icons", - "version": "3.29.1-next.0", + "version": "3.30.0", "private": false, "description": "A collection of UI SVG icons created by Esri for applications.", "keywords": [