mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 10:21:05 +00:00
Compare commits
2 commits
master
...
v1.0.0-nex
| Author | SHA1 | Date | |
|---|---|---|---|
|
559701ec86 | ||
|
|
c0d037dfca |
924 changed files with 17112 additions and 42626 deletions
1
.github/FUNDING.yml
vendored
1
.github/FUNDING.yml
vendored
|
|
@ -1 +0,0 @@
|
|||
github: metonym
|
||||
60
.github/workflows/checks.yml
vendored
60
.github/workflows/checks.yml
vendored
|
|
@ -1,60 +0,0 @@
|
|||
on:
|
||||
pull_request:
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
- "docs/**"
|
||||
- "examples/**"
|
||||
push:
|
||||
branches: [master]
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
- "docs/**"
|
||||
- "examples/**"
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: macos-15-xlarge
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "22.x"
|
||||
cache: "npm"
|
||||
- run: npm ci
|
||||
- run: npm run lint
|
||||
|
||||
test:
|
||||
runs-on: macos-15-xlarge
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "22.x"
|
||||
cache: "npm"
|
||||
- run: npm ci
|
||||
- run: npm run test
|
||||
|
||||
types:
|
||||
runs-on: macos-15-xlarge
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "22.x"
|
||||
cache: "npm"
|
||||
- run: npm ci
|
||||
- run: npm run test:src-types
|
||||
- run: npm run test:types
|
||||
|
||||
deploy-docs:
|
||||
if: github.ref == 'refs/heads/master'
|
||||
needs: [lint, test, types]
|
||||
runs-on: macos-15-xlarge
|
||||
steps:
|
||||
- name: Trigger deploy
|
||||
env:
|
||||
deploy_url: ${{ secrets.RENDER_DEPLOY_HOOK_URL }}
|
||||
run: curl -f "$deploy_url"
|
||||
29
.github/workflows/ci.yml
vendored
Normal file
29
.github/workflows/ci.yml
vendored
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: [master]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/cache@v3
|
||||
id: npm-cache
|
||||
with:
|
||||
path: "**/node_modules"
|
||||
key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
|
||||
|
||||
- name: Install dependencies, build, test, and lint the codebase
|
||||
run: |
|
||||
npm i
|
||||
npm run build:lib
|
||||
npm run test:types
|
||||
npm run lint
|
||||
|
||||
- name: Trigger deploy
|
||||
if: github.ref == 'refs/heads/master'
|
||||
env:
|
||||
deploy_url: ${{ secrets.RENDER_DEPLOY_HOOK_URL }}
|
||||
run: |
|
||||
curl "$deploy_url"
|
||||
24
.github/workflows/release.yml
vendored
24
.github/workflows/release.yml
vendored
|
|
@ -4,8 +4,8 @@ on:
|
|||
- "v*"
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: macos-latest-xlarge
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
id-token: write
|
||||
|
|
@ -13,25 +13,21 @@ jobs:
|
|||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "22.x"
|
||||
node-version: "18.x"
|
||||
registry-url: "https://registry.npmjs.org"
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm install
|
||||
|
||||
- name: Build docs
|
||||
run: npm run build:docs
|
||||
|
||||
- name: Prune package.json
|
||||
run: npx culls --preserve=svelte
|
||||
|
||||
- name: Build
|
||||
run: |
|
||||
npm install --force
|
||||
npm run build:docs & npm run build:lib
|
||||
- name: Publish package (stable)
|
||||
if: ${{ ! contains(github.ref, '-next') }}
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
|
||||
|
||||
# Currently, only npm supports publishing packages with provenance
|
||||
# https://docs.npmjs.com/generating-provenance-statements
|
||||
run: |
|
||||
npm publish --provenance --access public
|
||||
|
||||
- name: Publish package (next)
|
||||
if: ${{ contains(github.ref, '-next') }}
|
||||
env:
|
||||
|
|
|
|||
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -1,3 +1,4 @@
|
|||
lib
|
||||
node_modules
|
||||
.DS_Store
|
||||
.vscode
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
/lib
|
||||
/css
|
||||
/types
|
||||
.svelte-kit
|
||||
|
|
@ -6,4 +7,3 @@ dist
|
|||
client
|
||||
build
|
||||
*.svx
|
||||
COMPONENT_API.json
|
||||
271
CHANGELOG.md
271
CHANGELOG.md
|
|
@ -2,281 +2,16 @@
|
|||
|
||||
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
||||
|
||||
### [0.89.7](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.89.6...v0.89.7) (2025-09-05)
|
||||
## [1.0.0-next.0](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.82.8...v1.0.0-next.0) (2024-01-12)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **combo-box:** address accessibility issues ([#2186](https://github.com/carbon-design-system/carbon-components-svelte/issues/2186)) ([2fc884c](https://github.com/carbon-design-system/carbon-components-svelte/commit/2fc884cacabfffcf7779d6ef9ba01dece0bf5d86)), closes [#2172](https://github.com/carbon-design-system/carbon-components-svelte/issues/2172)
|
||||
- **data-table:** handle dynamic `headers` gracefully ([#2195](https://github.com/carbon-design-system/carbon-components-svelte/issues/2195)) ([6d0d3b1](https://github.com/carbon-design-system/carbon-components-svelte/commit/6d0d3b108bb4595d878fda20736c40b9656d14d7)), closes [#2193](https://github.com/carbon-design-system/carbon-components-svelte/issues/2193)
|
||||
- **overflow-menu:** avoid dynamic style injection for performance ([#2198](https://github.com/carbon-design-system/carbon-components-svelte/issues/2198)) ([14edf41](https://github.com/carbon-design-system/carbon-components-svelte/commit/14edf41e57fea1ddbb2cf24c37e79475849bdea1)), closes [#2197](https://github.com/carbon-design-system/carbon-components-svelte/issues/2197)
|
||||
- **pagination:** `on:change` dispatches with correct value ([#2194](https://github.com/carbon-design-system/carbon-components-svelte/issues/2194)) ([44a6cc0](https://github.com/carbon-design-system/carbon-components-svelte/commit/44a6cc0dfcbd3cdad1b442a760c9f604e58d56e6))
|
||||
|
||||
### [0.89.6](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.89.5...v0.89.6) (2025-08-16)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **toggle:** avoid dispatching `toggle` event on state change ([#2184](https://github.com/carbon-design-system/carbon-components-svelte/issues/2184)) ([0df727b](https://github.com/carbon-design-system/carbon-components-svelte/commit/0df727b704d6cc577681dc682269a6e224ddbb6e))
|
||||
|
||||
### [0.89.5](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.89.4...v0.89.5) (2025-08-05)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **checkbox:** prevent infinite effect loop when binding to same object ([#2178](https://github.com/carbon-design-system/carbon-components-svelte/issues/2178)) ([c7ad1eb](https://github.com/carbon-design-system/carbon-components-svelte/commit/c7ad1ebdd3764235f460abd95cdb7d1d389983d9)), closes [#2177](https://github.com/carbon-design-system/carbon-components-svelte/issues/2177)
|
||||
|
||||
### [0.89.4](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.89.3...v0.89.4) (2025-06-10)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **multi-select:** forward `on:input` for filterable variant ([#2170](https://github.com/carbon-design-system/carbon-components-svelte/issues/2170)) ([aecc4e8](https://github.com/carbon-design-system/carbon-components-svelte/commit/aecc4e8eec6571515233ec76ca06218814a279a7))
|
||||
|
||||
### [0.89.3](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.89.2...v0.89.3) (2025-06-07)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **combo-box:** "Escape" key clears input value ([#2169](https://github.com/carbon-design-system/carbon-components-svelte/issues/2169)) ([632320a](https://github.com/carbon-design-system/carbon-components-svelte/commit/632320ae3b8d9c602add0f4f7c708fc643cb7ffc)), closes [#2167](https://github.com/carbon-design-system/carbon-components-svelte/issues/2167)
|
||||
- **combo-box:** clear button supports "Space" key ([#2168](https://github.com/carbon-design-system/carbon-components-svelte/issues/2168)) ([95c06a8](https://github.com/carbon-design-system/carbon-components-svelte/commit/95c06a83b3afcbb76acfc0a5efe2f178d333ff19)), closes [#2166](https://github.com/carbon-design-system/carbon-components-svelte/issues/2166)
|
||||
|
||||
### [0.89.2](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.89.1...v0.89.2) (2025-04-28)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **composed-modal:** ignore a11y warning in Svelte 5 ([#2159](https://github.com/carbon-design-system/carbon-components-svelte/issues/2159)) ([024d774](https://github.com/carbon-design-system/carbon-components-svelte/commit/024d77493c93e7823e4781a1a60aaf350d289d52))
|
||||
- **pagination:** use `toLocaleString` for default text formatting ([#2161](https://github.com/carbon-design-system/carbon-components-svelte/issues/2161)) ([cdf5659](https://github.com/carbon-design-system/carbon-components-svelte/commit/cdf5659fa0177da77dc8ea1ccffdec54b746954b))
|
||||
- **pagination:** window `totalItems` for performance ([#2160](https://github.com/carbon-design-system/carbon-components-svelte/issues/2160)) ([ed3928b](https://github.com/carbon-design-system/carbon-components-svelte/commit/ed3928bb01ecca2fa63f551938dbee1c1829a978)), closes [#2156](https://github.com/carbon-design-system/carbon-components-svelte/issues/2156)
|
||||
- **to-hierarchy:** revert to previous implementation ([96d37cc](https://github.com/carbon-design-system/carbon-components-svelte/commit/96d37cc490f28830264c35c84447ee4526256314))
|
||||
|
||||
### [0.89.1](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.89.0...v0.89.1) (2025-04-21)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **toolbar-search:** re-filter rows if `DataTable` rows change ([#2154](https://github.com/carbon-design-system/carbon-components-svelte/issues/2154)) ([f09c2e2](https://github.com/carbon-design-system/carbon-components-svelte/commit/f09c2e2c311c15f633db8dc45930d8e58a4b362d)), closes [#2143](https://github.com/carbon-design-system/carbon-components-svelte/issues/2143)
|
||||
|
||||
### [0.89.0](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.88.4...v0.89.0) (2025-04-18)
|
||||
|
||||
### Features
|
||||
|
||||
- **combo-box:** add `hideLabel` prop ([#2153](https://github.com/carbon-design-system/carbon-components-svelte/issues/2153)) ([436dea4](https://github.com/carbon-design-system/carbon-components-svelte/commit/436dea47e8da35753a257c9b2bd6f33338e95ba5))
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **select:** falsy item `text` should fallback to `value` ([#2152](https://github.com/carbon-design-system/carbon-components-svelte/issues/2152)) ([61ea8dd](https://github.com/carbon-design-system/carbon-components-svelte/commit/61ea8dd82c2f9863dfe5f8a882e73624b994d9e5))
|
||||
|
||||
### [0.88.4](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.88.3...v0.88.4) (2025-03-24)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **list-box-selection:** fix `aria-label` for clear button ([#2134](https://github.com/carbon-design-system/carbon-components-svelte/issues/2134)) ([dd1338f](https://github.com/carbon-design-system/carbon-components-svelte/commit/dd1338ffc47926a13e231d4a0f724e923f2219e2))
|
||||
- **list-box:** correct button/description translations based on selection count ([#2139](https://github.com/carbon-design-system/carbon-components-svelte/issues/2139)) ([1a5f2d8](https://github.com/carbon-design-system/carbon-components-svelte/commit/1a5f2d8e67734bfda20272ae6a77d13b3837416d))
|
||||
- **list-box:** set `aria-disabled` if `disabled` ([#2125](https://github.com/carbon-design-system/carbon-components-svelte/issues/2125)) ([#2138](https://github.com/carbon-design-system/carbon-components-svelte/issues/2138)) ([9b61af0](https://github.com/carbon-design-system/carbon-components-svelte/commit/9b61af0306b422acf1e7cdde278e517740f667c5)), closes [#2130](https://github.com/carbon-design-system/carbon-components-svelte/issues/2130)
|
||||
- **radio-button:** forward `focus`, `blur` events ([#2135](https://github.com/carbon-design-system/carbon-components-svelte/issues/2135)) ([1462e30](https://github.com/carbon-design-system/carbon-components-svelte/commit/1462e300d69f0cd7ee5476dfe3a7ea892ac8f4ad)), closes [#2131](https://github.com/carbon-design-system/carbon-components-svelte/issues/2131)
|
||||
- **radio-tile:** allow standalone `RadioTile` usage ([#2136](https://github.com/carbon-design-system/carbon-components-svelte/issues/2136)) ([ca9beeb](https://github.com/carbon-design-system/carbon-components-svelte/commit/ca9beebaeac7eaed8079c010a86a78926b00147f))
|
||||
- **text-area:** allow visually hidden label ([#2137](https://github.com/carbon-design-system/carbon-components-svelte/issues/2137)) ([43511e0](https://github.com/carbon-design-system/carbon-components-svelte/commit/43511e09ecf312c1b8e9339856b9d7d0785036de))
|
||||
|
||||
### [0.88.3](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.88.2...v0.88.3) (2025-03-19)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- Revert **list-box:** use `aria-disabled` instead of invalid `disabled` attribute ([#2125](https://github.com/carbon-design-system/carbon-components-svelte/issues/2125)) ([e1b3ef2](https://github.com/carbon-design-system/carbon-components-svelte/commit/e1b3ef22c9ee09474bacadbb0b22b41326566bab))
|
||||
|
||||
### [0.88.2](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.88.1...v0.88.2) (2025-03-19)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **combo-box:** fix typing when refocusing input ([9e3d830](https://github.com/carbon-design-system/carbon-components-svelte/commit/9e3d83031e69889472c4e84be256ea242854cf81))
|
||||
- **list-box:** use `aria-disabled` instead of invalid `disabled` attribute ([#2125](https://github.com/carbon-design-system/carbon-components-svelte/issues/2125)) ([e1b3ef2](https://github.com/carbon-design-system/carbon-components-svelte/commit/e1b3ef22c9ee09474bacadbb0b22b41326566bab))
|
||||
- **multi-select:** fix keyboard navigation for disabled items ([#2129](https://github.com/carbon-design-system/carbon-components-svelte/issues/2129)) ([e7939ff](https://github.com/carbon-design-system/carbon-components-svelte/commit/e7939ff0e21c3430c9eea74c503b7c35f6823445)), closes [#2128](https://github.com/carbon-design-system/carbon-components-svelte/issues/2128)
|
||||
- **notification:** remove invalid `kind` prop from markup ([#2126](https://github.com/carbon-design-system/carbon-components-svelte/issues/2126)) ([e85d7ef](https://github.com/carbon-design-system/carbon-components-svelte/commit/e85d7efc5ed15f5236d074fd7981ae527d9e5ab5))
|
||||
- **theme:** remove invalid `themes` prop from markup ([#2127](https://github.com/carbon-design-system/carbon-components-svelte/issues/2127)) ([5987b61](https://github.com/carbon-design-system/carbon-components-svelte/commit/5987b61a5522fff09468bddd586eed4a537edcc8))
|
||||
|
||||
### [0.88.1](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.88.0...v0.88.1) (2025-03-12)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **select:** falsy item `text` should not override `value` ([#2118](https://github.com/carbon-design-system/carbon-components-svelte/issues/2118)) ([663b79a](https://github.com/carbon-design-system/carbon-components-svelte/commit/663b79ad054d14a91a8bf700feb62dcf50976eb8)), closes [#2117](https://github.com/carbon-design-system/carbon-components-svelte/issues/2117)
|
||||
- **ui-shell:** `HeaderAction` uses dark color scheme ([#2119](https://github.com/carbon-design-system/carbon-components-svelte/issues/2119)) ([7ff93ad](https://github.com/carbon-design-system/carbon-components-svelte/commit/7ff93ad2dac489859d5b4a83c1e359a6507718b4))
|
||||
|
||||
### [0.88.0](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.87.7...v0.88.0) (2025-03-09)
|
||||
|
||||
### Features
|
||||
|
||||
- **data-table:** allow custom `inputName` for radio/checkbox ([#2087](https://github.com/carbon-design-system/carbon-components-svelte/issues/2087)) ([7481b9a](https://github.com/carbon-design-system/carbon-components-svelte/commit/7481b9a995dfbc8c2fbaeaae143c8372cf5fce66)), closes [#2085](https://github.com/carbon-design-system/carbon-components-svelte/issues/2085)
|
||||
- **ui-shell:** `HeaderAction` supports tooltip ([#2111](https://github.com/carbon-design-system/carbon-components-svelte/issues/2111)) ([24b9cbc](https://github.com/carbon-design-system/carbon-components-svelte/commit/24b9cbc9c343537e5e74799ef8289bd29396cf04)), closes [#2110](https://github.com/carbon-design-system/carbon-components-svelte/issues/2110)
|
||||
|
||||
### [0.87.7](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.87.6...v0.87.7) (2025-03-07)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **select:** avoid infinite update loop in Svelte 5 ([#2108](https://github.com/carbon-design-system/carbon-components-svelte/issues/2108)) ([9b4bfa6](https://github.com/carbon-design-system/carbon-components-svelte/commit/9b4bfa6f86e23155516db156cbe1c980f3c699e8)), closes [#2107](https://github.com/carbon-design-system/carbon-components-svelte/issues/2107)
|
||||
|
||||
### [0.87.6](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.87.5...v0.87.6) (2025-02-24)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **overflow-menu:** add `aria-controls` to trigger button ([#2100](https://github.com/carbon-design-system/carbon-components-svelte/issues/2100)) ([b7297d4](https://github.com/carbon-design-system/carbon-components-svelte/commit/b7297d452a7813c02f3c89280787292b1c46acec))
|
||||
|
||||
### [0.87.5](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.87.4...v0.87.5) (2025-02-04)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **tag:** allow `on:close` to work with Svelte 5 ([#2097](https://github.com/carbon-design-system/carbon-components-svelte/issues/2097)) ([6e65ef3](https://github.com/carbon-design-system/carbon-components-svelte/commit/6e65ef39e7ff9a3c0ee25b7945a62584e9b7441e)), closes [#2096](https://github.com/carbon-design-system/carbon-components-svelte/issues/2096)
|
||||
|
||||
### [0.87.4](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.87.3...v0.87.4) (2025-02-02)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **types:** loosen `icon` prop type to `any` ([#2095](https://github.com/carbon-design-system/carbon-components-svelte/issues/2095)) ([6bf72d4](https://github.com/carbon-design-system/carbon-components-svelte/commit/6bf72d46024ad2ce03651f28fc1a2a95ec03385d))
|
||||
|
||||
### [0.87.3](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.87.2...v0.87.3) (2025-01-30)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **overflow-menu:** support Svelte 5 ([88f4304](https://github.com/carbon-design-system/carbon-components-svelte/commit/88f4304d5a7c9b38b3cabda677233bef48fb9e3a)), closes [#2092](https://github.com/carbon-design-system/carbon-components-svelte/issues/2092)
|
||||
|
||||
### [0.87.2](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.87.1...v0.87.2) (2025-01-22)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **text-area:** counter supports null `value` ([#2089](https://github.com/carbon-design-system/carbon-components-svelte/issues/2089)) ([76eec84](https://github.com/carbon-design-system/carbon-components-svelte/commit/76eec84c5458d07d61d057d9ff06938e244dbb2c))
|
||||
|
||||
### [0.87.1](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.87.0...v0.87.1) (2025-01-19)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **data-table:** improve `expandable` accessibility ([#2086](https://github.com/carbon-design-system/carbon-components-svelte/issues/2086)) ([e874ac1](https://github.com/carbon-design-system/carbon-components-svelte/commit/e874ac19d778a00c0bba9be65d10be7e6c9104dd))
|
||||
- **data-table:** prefix internal ID for radio button, checkbox ([#2082](https://github.com/carbon-design-system/carbon-components-svelte/issues/2082)) ([dd6cbac](https://github.com/carbon-design-system/carbon-components-svelte/commit/dd6cbac3ee1728dbcba5cd1d8faa43941e2a198e)), closes [#2081](https://github.com/carbon-design-system/carbon-components-svelte/issues/2081)
|
||||
- **dropdown:** avoid manual field `blur` ([c194c80](https://github.com/carbon-design-system/carbon-components-svelte/commit/c194c80e29ab36935af71adb9e166e9a16b70910)), closes [#2083](https://github.com/carbon-design-system/carbon-components-svelte/issues/2083)
|
||||
- **multi-select:** avoid manual field `blur` ([fb6719b](https://github.com/carbon-design-system/carbon-components-svelte/commit/fb6719b1aee35aa45004d82e3b923b4ad45dff5d)), closes [#2083](https://github.com/carbon-design-system/carbon-components-svelte/issues/2083)
|
||||
|
||||
### [0.87.0](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.86.2...v0.87.0) (2024-12-09)
|
||||
|
||||
### Features
|
||||
|
||||
- add `toHierarchy` utility to normalize flat data into `nodes` for `TreeView`, `RecursiveList` ([#2072](https://github.com/carbon-design-system/carbon-components-svelte/issues/2072)) ([48afd18](https://github.com/carbon-design-system/carbon-components-svelte/commit/48afd18e5e01c2839024b8ddb31038267bcedeb8))
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **tooltip-icon:** `button` should have explicit `type` ([#2071](https://github.com/carbon-design-system/carbon-components-svelte/issues/2071)) ([18c964e](https://github.com/carbon-design-system/carbon-components-svelte/commit/18c964e579a3762b8022751bf0ed5313b78b22ba))
|
||||
|
||||
### [0.86.2](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.86.1...v0.86.2) (2024-11-30)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **multi-select:** fix sorting behavior ([c3a390f](https://github.com/carbon-design-system/carbon-components-svelte/commit/c3a390f3fef072c6b736e33a85a2ae772df12e52)), closes [#2066](https://github.com/carbon-design-system/carbon-components-svelte/issues/2066)
|
||||
|
||||
## [0.86.1](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.86.0...v0.86.1) (2024-11-22)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **tree-view:** do not flatten original `nodes` ([#2056](https://github.com/carbon-design-system/carbon-components-svelte/issues/2056)) ([e488c88](https://github.com/carbon-design-system/carbon-components-svelte/commit/e488c8837146432330ebbf2f9182a8a69eab6b70))
|
||||
|
||||
## [0.86.0](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.85.4...v0.86.0) (2024-11-20)
|
||||
|
||||
### ⚠ BREAKING CHANGES
|
||||
|
||||
- **package:** set `type="module"` in `package.json`
|
||||
- **package:** remove bundled ESM/UMD support
|
||||
- **treeview:** rename `children` prop to `nodes` for Svelte 5 compatibility
|
||||
- **recursive-list:** rename `children` prop to `nodes` for Svelte 5 compatibility
|
||||
- **types:** use type alias instead of interface for exported component props ([6fbd8ae](https://github.com/carbon-design-system/carbon-components-svelte/commit/6fbd8ae6a90eabde74fb5481c980716eba477c31))
|
||||
* initial pre-release - Carbon v11 styles (#1881)
|
||||
|
||||
### Features
|
||||
|
||||
- **data-table:** support TypeScript generics ([#1954](https://github.com/carbon-design-system/carbon-components-svelte/issues/1954)) ([dd43224](https://github.com/carbon-design-system/carbon-components-svelte/commit/dd43224119905c3a26a2369f836338c18fcbafba))
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **data-table:** (Svelte 5 compatibility) handle `ToolbarSearch` filtering in `DataTable` ([#2037](https://github.com/carbon-design-system/carbon-components-svelte/issues/2037)) ([3192824](https://github.com/carbon-design-system/carbon-components-svelte/commit/3192824322faef7c0c012eb246bb6ef9da7f78dc))
|
||||
- **multi-select:** (Svelte 5 compatibility) avoid cyclic dependency ([#2034](https://github.com/carbon-design-system/carbon-components-svelte/issues/2034)) ([1acd713](https://github.com/carbon-design-system/carbon-components-svelte/commit/1acd7135372eeabf002dacc80e39162989427140))
|
||||
- **toolbar-menu:** (Svelte 5 compatibility) remove redundant menu offset ([#2047](https://github.com/carbon-design-system/carbon-components-svelte/issues/2047)) ([7e17394](https://github.com/carbon-design-system/carbon-components-svelte/commit/7e173943ac783756521c4957a1c24b5288ab45b7)), closes [#2040](https://github.com/carbon-design-system/carbon-components-svelte/issues/2040)
|
||||
- **checkbox:** (Svelte 5 compatibility) bind `indeterminate` ([#2044](https://github.com/carbon-design-system/carbon-components-svelte/issues/2044)) ([9d5e7e3](https://github.com/carbon-design-system/carbon-components-svelte/commit/9d5e7e31efb2d439b18ba0bf350b712377e160a7)), closes [#2039](https://github.com/carbon-design-system/carbon-components-svelte/issues/2039)
|
||||
|
||||
### [0.85.4](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.85.3...v0.85.4) (2024-11-09)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **combo-box:** fix types for `on:clear` ([#2020](https://github.com/carbon-design-system/carbon-components-svelte/issues/2020)) ([0831e87](https://github.com/carbon-design-system/carbon-components-svelte/commit/0831e871358fe012e9907699f1423b7e36dba0da))
|
||||
- **data-table:** fix `DataTableValue` type reference in `DataTable` ([#2023](https://github.com/carbon-design-system/carbon-components-svelte/issues/2023)) ([44daa77](https://github.com/carbon-design-system/carbon-components-svelte/commit/44daa775d5e4dc9aef66eae0e661f14fb5b41354))
|
||||
- **theme:** `Theme` correctly imports `toggle`, `select` props ([#2019](https://github.com/carbon-design-system/carbon-components-svelte/issues/2019)) ([49b5def](https://github.com/carbon-design-system/carbon-components-svelte/commit/49b5def8153f5eec523d56e2a2c6d4cc3a36dcb5)), closes [#2018](https://github.com/carbon-design-system/carbon-components-svelte/issues/2018)
|
||||
- **toolbar-search:** fix types for `on:clear` ([#2022](https://github.com/carbon-design-system/carbon-components-svelte/issues/2022)) ([58e6021](https://github.com/carbon-design-system/carbon-components-svelte/commit/58e6021b08f311a5bb3cc7c7f181443cc633c8e4))
|
||||
- **types:** delete extraneous `icons/Search.svelte.d.ts` ([#2025](https://github.com/carbon-design-system/carbon-components-svelte/issues/2025)) ([951d686](https://github.com/carbon-design-system/carbon-components-svelte/commit/951d6860423fc05df9f46e29fb19916b89c48466))
|
||||
- **types:** fix types for `on:paste` event ([3167e44](https://github.com/carbon-design-system/carbon-components-svelte/commit/3167e449fdaf19abb4cdf1e2bf3f5bec24865f89))
|
||||
|
||||
### [0.85.3](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.85.2...v0.85.3) (2024-10-25)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- address Svelte 5 warnings ([#2011](https://github.com/carbon-design-system/carbon-components-svelte/issues/2011)) ([43fccac](https://github.com/carbon-design-system/carbon-components-svelte/commit/43fccac1c6273d9aa83b8c26a5f8cecec667db59))
|
||||
|
||||
### [0.85.2](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.85.1...v0.85.2) (2024-08-14)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **header-action:** allow vertical scroll when expanded ([#1992](https://github.com/carbon-design-system/carbon-components-svelte/issues/1992)) ([61eceb0](https://github.com/carbon-design-system/carbon-components-svelte/commit/61eceb0caac20d92ce58c23d26908530a7e32dbe))
|
||||
|
||||
### [0.85.1](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.85.0...v0.85.1) (2024-08-09)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **multi-select:** fix `filterItem` return type ([#1972](https://github.com/carbon-design-system/carbon-components-svelte/issues/1972)) ([6140c3c](https://github.com/carbon-design-system/carbon-components-svelte/commit/6140c3c5a91a879889be33080e1aa8b9183982d4))
|
||||
- **search:** collapse expandable search if value is falsy ([#1987](https://github.com/carbon-design-system/carbon-components-svelte/issues/1987)) ([216d5a3](https://github.com/carbon-design-system/carbon-components-svelte/commit/216d5a39b14ddad600159c1159b6a2d38095cfaf)), closes [#1981](https://github.com/carbon-design-system/carbon-components-svelte/issues/1981)
|
||||
- **text-area:** type `value` prop as nullable ([#1933](https://github.com/carbon-design-system/carbon-components-svelte/issues/1933)) ([47860ce](https://github.com/carbon-design-system/carbon-components-svelte/commit/47860ce1d7cc5f3b0363ab619dcfd74b3276eda7))
|
||||
|
||||
## [0.85.0](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.84.1...v0.85.0) (2024-03-23)
|
||||
|
||||
### ⚠ BREAKING CHANGES
|
||||
|
||||
- use `:global()` for custom UI Shell styles ([#1940](https://github.com/carbon-design-system/carbon-components-svelte/issues/1940)) ([d5a1148](https://github.com/carbon-design-system/carbon-components-svelte/commit/d5a11489f8ab9dc05751aa20c420ea4dc6249567))
|
||||
|
||||
### [0.84.1](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.84.0...v0.84.1) (2024-03-16)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **checkbox:** forward `on:focus`, `on:blur` to `Checkbox` and `InlineCheckbox` ([#1937](https://github.com/carbon-design-system/carbon-components-svelte/issues/1937)) ([6364b23](https://github.com/carbon-design-system/carbon-components-svelte/commit/6364b23030cc0761aa6a0561a1673e89dde47868))
|
||||
- **data-table:** loosen `sort` return type to be a `number` ([#1935](https://github.com/carbon-design-system/carbon-components-svelte/issues/1935)) ([9132bf8](https://github.com/carbon-design-system/carbon-components-svelte/commit/9132bf8e5a2d6ba70d17a0b4fcdea29d0785492c)), closes [#1934](https://github.com/carbon-design-system/carbon-components-svelte/issues/1934)
|
||||
|
||||
### [0.84.0](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.83.0...v0.84.0) (2024-03-08)
|
||||
|
||||
### Features
|
||||
|
||||
- **ui-shell:** support button tooltip in `HeaderGlobalAction` ([#1894](https://github.com/carbon-design-system/carbon-components-svelte/issues/1894)) ([d8bc651](https://github.com/carbon-design-system/carbon-components-svelte/commit/d8bc65163eabacfee348d6248e90f683ac488aef)), closes [#1893](https://github.com/carbon-design-system/carbon-components-svelte/issues/1893)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **exports:** resolve imports with explicit \*.js extension ([#1927](https://github.com/carbon-design-system/carbon-components-svelte/issues/1927)) ([0405ede](https://github.com/carbon-design-system/carbon-components-svelte/commit/0405edee7d1696a157acab941488f8d3a750187f)), closes [#1925](https://github.com/carbon-design-system/carbon-components-svelte/issues/1925)
|
||||
|
||||
## [0.83.0](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.82.11...v0.83.0) (2024-03-07)
|
||||
|
||||
### ⚠ BREAKING CHANGES
|
||||
|
||||
- **link:** do not render `p` for disabled link
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- avoid using reserved `$` for Svelte 5 compat ([a0d5028](https://github.com/carbon-design-system/carbon-components-svelte/commit/a0d5028540e1bcbb3b37bf488c11ea94f97b5fa7))
|
||||
- **link:** do not render `p` for disabled link ([8bffc17](https://github.com/carbon-design-system/carbon-components-svelte/commit/8bffc17d650144ed0d5b778766f79c33334f0275)), closes [#1924](https://github.com/carbon-design-system/carbon-components-svelte/issues/1924)
|
||||
- **search:** hoist ignore `a11y autofocus` comment ([6152b78](https://github.com/carbon-design-system/carbon-components-svelte/commit/6152b784c1e6b19ff242524e6b0c8c98b0107788))
|
||||
|
||||
### [0.82.11](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.82.10...v0.82.11) (2024-02-26)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **code-snippet:** `showMoreLess={false}` should hide button ([4085536](https://github.com/carbon-design-system/carbon-components-svelte/commit/40855361891c2388c2b775803bcac937fbd6c1d6)), closes [#1536](https://github.com/carbon-design-system/carbon-components-svelte/issues/1536)
|
||||
- **image-loader:** updated `src` should update the image ([0f318aa](https://github.com/carbon-design-system/carbon-components-svelte/commit/0f318aac7732c2b94ec0729d54416611fbd0d493)), closes [#1677](https://github.com/carbon-design-system/carbon-components-svelte/issues/1677)
|
||||
- **overflow-menu:** use `offsetWidth`, `offsetHeight` to compute menu dimensions ([#1913](https://github.com/carbon-design-system/carbon-components-svelte/issues/1913)) ([2404244](https://github.com/carbon-design-system/carbon-components-svelte/commit/24042442213ca9daa0cf663aabf37b3544e9c364))
|
||||
- **toast-notification:** fire `on:clear` from timeout correctly ([9aabe3c](https://github.com/carbon-design-system/carbon-components-svelte/commit/9aabe3cbbb05712b71f5cad7c571b170c1f3a439)), closes [#1914](https://github.com/carbon-design-system/carbon-components-svelte/issues/1914)
|
||||
|
||||
### [0.82.10](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.82.9...v0.82.10) (2024-02-12)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **slider:** dispatch `on:input` event ([#1906](https://github.com/carbon-design-system/carbon-components-svelte/issues/1906)) ([90dbd15](https://github.com/carbon-design-system/carbon-components-svelte/commit/90dbd1562b04df3cf4de28874b6e790ddca1db81)), closes [#1643](https://github.com/carbon-design-system/carbon-components-svelte/issues/1643)
|
||||
|
||||
### [0.82.9](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.82.8...v0.82.9) (2024-02-07)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- **context-menu:** prevent `on:contextmenu` default behavior only when opening menu ([#1911](https://github.com/carbon-design-system/carbon-components-svelte/issues/1911)) ([4ad522c](https://github.com/carbon-design-system/carbon-components-svelte/commit/4ad522c197d4a389a6187a499e9e54d5d8b3994a)), closes [#1909](https://github.com/carbon-design-system/carbon-components-svelte/issues/1909)
|
||||
- **types:** improve `e.detail` type for dispatched events ([#1907](https://github.com/carbon-design-system/carbon-components-svelte/issues/1907)) ([6590457](https://github.com/carbon-design-system/carbon-components-svelte/commit/65904575743ba06344fb75e14685e42494c13cde))
|
||||
* initial pre-release - Carbon v11 styles ([#1881](https://github.com/carbon-design-system/carbon-components-svelte/issues/1881)) ([b807a34](https://github.com/carbon-design-system/carbon-components-svelte/commit/b807a3437deee96d74839960344d8e40a1bc9164)), closes [#1872](https://github.com/carbon-design-system/carbon-components-svelte/issues/1872)
|
||||
|
||||
### [0.82.8](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.82.7...v0.82.8) (2024-01-10)
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -2,10 +2,23 @@
|
|||
|
||||
Before submitting a pull request (PR), consider [filing an issue](https://github.com/carbon-design-system/carbon-components-svelte/issues) to gain clarity and direction.
|
||||
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Project set-up](#project-set-up)
|
||||
- [Install](#install)
|
||||
- [Documentation set-up](#documentation-set-up)
|
||||
- [Development workflow](#development-workflow)
|
||||
- [Component Format](#component-format)
|
||||
- [Editing a component](#editing-a-component)
|
||||
- [Creating a component](#creating-a-component)
|
||||
- [Run `npm run build:docs`](#run-npm-run-builddocs)
|
||||
- [Submit a Pull Request](#submit-a-pull-request)
|
||||
- [Sync Your Fork](#sync-your-fork)
|
||||
- [Submit a PR](#submit-a-pr)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- [Node.js](https://nodejs.org/en/download/package-manager/) (version >=20)
|
||||
- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-nodejs-and-npm)
|
||||
- [Node.js](https://nodejs.org/en/download/package-manager/) (version >=18)
|
||||
- [npm](https://docs.npmjs.com/cli) (bundled with Node.js)
|
||||
|
||||
## Project set-up
|
||||
|
||||
|
|
@ -26,9 +39,10 @@ git remote -v
|
|||
|
||||
### Install
|
||||
|
||||
Install the project dependencies.
|
||||
Install the project dependencies:
|
||||
|
||||
```sh
|
||||
# carbon-components-svelte/
|
||||
npm install
|
||||
```
|
||||
|
||||
|
|
@ -36,16 +50,22 @@ npm install
|
|||
|
||||
Component documentation is located in the `docs` folder. The website is built using svite, routify, and MDsveX. You will need to create a symbolic project link in order to see live changes reflected when developing locally.
|
||||
|
||||
First, create a symbolic link at the root of the project:
|
||||
First, create a symbolic link at the root of the project folder:
|
||||
|
||||
```sh
|
||||
# carbon-components-svelte/
|
||||
npm link
|
||||
```
|
||||
|
||||
Then, go into `docs` and link the package.
|
||||
Go into the `docs` folder:
|
||||
|
||||
```sh
|
||||
cd docs
|
||||
```
|
||||
|
||||
Link `"carbon-components-svelte"`:
|
||||
|
||||
```sh
|
||||
npm link "carbon-components-svelte"
|
||||
npm install
|
||||
```
|
||||
|
|
@ -70,7 +90,7 @@ In the `docs` folder, run:
|
|||
npm run dev
|
||||
```
|
||||
|
||||
The site should be served at http://localhost:5173/ (or the next available port).
|
||||
The site should be served at `http://localhost:3000/` (or the next available port).
|
||||
|
||||
### Component Format
|
||||
|
||||
|
|
@ -119,6 +139,7 @@ export {
|
|||
Run the following command to re-generate TypeScript definitions and documentation.
|
||||
|
||||
```sh
|
||||
# carbon-components-svelte/
|
||||
npm run build:docs
|
||||
```
|
||||
|
||||
|
|
|
|||
141
README.md
141
README.md
|
|
@ -13,9 +13,9 @@ Design systems facilitate design and development through reuse, consistency, and
|
|||
|
||||
The Carbon Svelte portfolio also includes:
|
||||
|
||||
- **[Carbon Icons Svelte](https://github.com/carbon-design-system/carbon-icons-svelte)**: 2,500+ Carbon icons as Svelte components
|
||||
- **[Carbon Pictograms Svelte](https://github.com/carbon-design-system/carbon-pictograms-svelte)**: 1,300+ Carbon pictograms as Svelte components
|
||||
- **[Carbon Charts Svelte](https://github.com/carbon-design-system/carbon-charts/tree/master/packages/svelte)**: 25+ charts, powered by d3
|
||||
- **[Carbon Icons Svelte](https://github.com/carbon-design-system/carbon-icons-svelte)**: 2,200+ Carbon icons as Svelte components
|
||||
- **[Carbon Pictograms Svelte](https://github.com/carbon-design-system/carbon-pictograms-svelte)**: 1,100+ Carbon pictograms as Svelte components
|
||||
- **[Carbon Charts Svelte](https://github.com/carbon-design-system/carbon-charts/tree/master/packages/svelte)**: 20+ charts, powered by d3
|
||||
- **[Carbon Preprocess Svelte](https://github.com/carbon-design-system/carbon-preprocess-svelte)**: Collection of Svelte preprocessors for Carbon
|
||||
|
||||
## [Documentation](https://svelte.carbondesignsystem.com)
|
||||
|
|
@ -28,29 +28,27 @@ Other forms of documentation are auto-generated:
|
|||
|
||||
## Installation
|
||||
|
||||
Install `carbon-components-svelte` as a development dependency.
|
||||
|
||||
```sh
|
||||
# Yarn
|
||||
yarn add -D carbon-components-svelte
|
||||
|
||||
# npm
|
||||
npm i carbon-components-svelte
|
||||
npm i -D carbon-components-svelte
|
||||
|
||||
# pnpm
|
||||
pnpm i carbon-components-svelte
|
||||
|
||||
# Yarn
|
||||
yarn add carbon-components-svelte
|
||||
|
||||
# Bun
|
||||
bun add carbon-components-svelte
|
||||
pnpm i -D carbon-components-svelte
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Styling
|
||||
|
||||
Before importing components, you will need to first apply Carbon component styles. The Carbon Design System supports five themes (2 light, 3 dark).
|
||||
Before importing components, you will need to first apply Carbon component styles. The Carbon Design System supports four themes (2 light, 2 dark).
|
||||
|
||||
- **white.css**: Default Carbon theme (light)
|
||||
- **g10.css**: Gray 10 theme (light)
|
||||
- **g80.css**: Gray 80 theme (dark)
|
||||
- **g90.css**: Gray 90 theme (dark)
|
||||
- **g100.css**: Gray 100 theme (dark)
|
||||
- **all.css**: All themes (White, Gray 10, Gray 90, Gray 100) using [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties)
|
||||
|
|
@ -61,7 +59,6 @@ The compiled CSS is generated from the following `.scss` files:
|
|||
|
||||
- [css/white.scss](css/white.scss)
|
||||
- [css/g10.scss](css/g10.scss)
|
||||
- [css/g80.scss](css/g80.scss)
|
||||
- [css/g90.scss](css/g90.scss)
|
||||
- [css/g100.scss](css/g100.scss)
|
||||
- [css/all.scss](css/all.scss)
|
||||
|
|
@ -75,9 +72,6 @@ import "carbon-components-svelte/css/white.css";
|
|||
// Gray 10 theme
|
||||
import "carbon-components-svelte/css/g10.css";
|
||||
|
||||
// Gray 80 theme
|
||||
import "carbon-components-svelte/css/g80.css";
|
||||
|
||||
// Gray 90 theme
|
||||
import "carbon-components-svelte/css/g90.css";
|
||||
|
||||
|
|
@ -88,6 +82,37 @@ import "carbon-components-svelte/css/g100.css";
|
|||
import "carbon-components-svelte/css/all.css";
|
||||
```
|
||||
|
||||
#### CDN
|
||||
|
||||
An alternative to loading styles is to link an external StyleSheet from a Content Delivery Network (CDN) like [unpkg.com](https://unpkg.com/).
|
||||
|
||||
This is best suited for rapid prototyping.
|
||||
|
||||
##### HTML
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://unpkg.com/carbon-components-svelte/css/white.css"
|
||||
/>
|
||||
</head>
|
||||
</html>
|
||||
```
|
||||
|
||||
##### `svelte:head`
|
||||
|
||||
```html
|
||||
<svelte:head>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://unpkg.com/carbon-components-svelte/css/white.css"
|
||||
/>
|
||||
</svelte:head>
|
||||
```
|
||||
|
||||
### SCSS
|
||||
|
||||
The most performant method to load styles is to import SCSS directly from carbon-components. Although it requires more set up, you can reduce the size of the bundle CSS by importing individual component styles instead of a pre-compiled CSS StyleSheet.
|
||||
|
|
@ -105,7 +130,7 @@ import "carbon-components-svelte/css/all.css";
|
|||
Update the theme by setting the `theme` attribute on the `html` element. The default `theme` is `"white"`.
|
||||
|
||||
```html
|
||||
<!doctype html>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" theme="g10">
|
||||
<body>
|
||||
...
|
||||
|
|
@ -117,7 +142,7 @@ Programmatically switch between each of the five Carbon themes by setting the "t
|
|||
|
||||
```html
|
||||
<script>
|
||||
let theme = "white"; // "white" | "g10" | "g80" | "g90" | "g100"
|
||||
let theme = "white"; // "white" | "g10" | "g90" | "g100"
|
||||
|
||||
$: document.documentElement.setAttribute("theme", theme);
|
||||
</script>
|
||||
|
|
@ -142,30 +167,24 @@ Import components from `carbon-components-svelte` in the `script` tag of your Sv
|
|||
|
||||
**Refer to [COMPONENT_INDEX.md](COMPONENT_INDEX.md) for component API documentation.**
|
||||
|
||||
## Preprocessors & Plugins
|
||||
## Preprocessors
|
||||
|
||||
[carbon-preprocess-svelte](https://github.com/carbon-design-system/carbon-preprocess-svelte) is a collection of Svelte preprocessors for Carbon.
|
||||
|
||||
> [!NOTE]
|
||||
> Using `carbon-preprocess-svelte` is optional and not a prerequisite for this library. It should be installed as a development dependency.
|
||||
|
||||
```sh
|
||||
# Yarn
|
||||
yarn add -D carbon-preprocess-svelte
|
||||
|
||||
# npm
|
||||
npm i -D carbon-preprocess-svelte
|
||||
|
||||
# pnpm
|
||||
pnpm i -D carbon-preprocess-svelte
|
||||
|
||||
# Yarn
|
||||
yarn add -D carbon-preprocess-svelte
|
||||
|
||||
# Bun
|
||||
bun add -D carbon-preprocess-svelte
|
||||
```
|
||||
|
||||
### `optimizeImports`
|
||||
|
||||
`optimizeImports` is a Svelte preprocessor that rewrites barrel imports from Carbon components/icons/pictograms packages to their source Svelte code paths. This can significantly speed up development and production build compile times while preserving typeahead and autocompletion offered by integrated development environments (IDE) like VS Code.
|
||||
`optimizeImports` is a script preprocessor that rewrites base imports from Carbon components/icons/pictograms packages to their source Svelte code paths. This can greatly speed up compile times during development while preserving typeahead and autocompletion hinting offered by integrated development environments (IDE) like VSCode.
|
||||
|
||||
The preprocessor optimizes imports from the following packages:
|
||||
|
||||
|
|
@ -177,19 +196,15 @@ The preprocessor optimizes imports from the following packages:
|
|||
|
||||
```diff
|
||||
- import { Button } from "carbon-components-svelte";
|
||||
+ import Button from "carbon-components-svelte/src/Button/Button.svelte";
|
||||
|
||||
- import { Add } from "carbon-icons-svelte";
|
||||
+ import Add from "carbon-icons-svelte/lib/Add.svelte";
|
||||
|
||||
- import { Add16 } from "carbon-icons-svelte";
|
||||
- import { Airplane } from "carbon-pictograms-svelte";
|
||||
+ import Button from "carbon-components-svelte/src/Button/Button.svelte";
|
||||
+ import Add16 from "carbon-icons-svelte/lib/Add16.svelte";
|
||||
+ import Airplane from "carbon-pictograms-svelte/lib/Airplane.svelte";
|
||||
```
|
||||
|
||||
#### Usage
|
||||
|
||||
See [examples](examples) for full configurations.
|
||||
|
||||
```js
|
||||
// svelte.config.js
|
||||
import { optimizeImports } from "carbon-preprocess-svelte";
|
||||
|
|
@ -199,59 +214,21 @@ export default {
|
|||
};
|
||||
```
|
||||
|
||||
Any other preprocessors that transpile code in the `script` block should be invoked before `optimizeImports`.
|
||||
|
||||
For example, `vitePreprocess` should precede `optimizeImports`.
|
||||
`svelte-preprocess` should be invoked before any preprocessor from `carbon-preprocess-svelte`.
|
||||
|
||||
```diff
|
||||
// svelte.config.js
|
||||
+ import { vitePreprocess } from "@sveltejs/vite-plugin-svelte";
|
||||
+ import sveltePreprocess from "svelte-preprocess";
|
||||
import { optimizeImports } from "carbon-preprocess-svelte";
|
||||
|
||||
export default {
|
||||
preprocess: [
|
||||
+ vitePreprocess(),
|
||||
+ sveltePreprocess(),
|
||||
optimizeImports()
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
### `optimizeCss`
|
||||
|
||||
`optimizeCss` is a Vite plugin that removes unused Carbon styles at build time. The plugin is compatible with Rollup ([Vite](https://vitejs.dev/guide/api-plugin) extends the Rollup plugin API).
|
||||
|
||||
`carbon-components-svelte@0.85.0` or greater is required.
|
||||
|
||||
```diff
|
||||
$ vite build
|
||||
|
||||
Optimized index-CU4gbKFa.css
|
||||
- Before: 606.26 kB
|
||||
+ After: 53.22 kB (-91.22%)
|
||||
|
||||
dist/index.html 0.34 kB │ gzip: 0.24 kB
|
||||
dist/assets/index-CU4gbKFa.css 53.22 kB │ gzip: 6.91 kB
|
||||
dist/assets/index-Ceijs3eO.js 53.65 kB │ gzip: 15.88 kB
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> This is a plugin and not a Svelte preprocessor. It should be added to the list of `vite.plugins`. For Vite set-ups, this plugin is only run when building the app. For Rollup and Webpack, you should conditionally apply the plugin to only execute when building for production.
|
||||
|
||||
#### Usage
|
||||
|
||||
See [examples](examples) for full configurations.
|
||||
|
||||
```js
|
||||
// vite.config.js
|
||||
import { sveltekit } from "@sveltejs/kit/vite";
|
||||
import { optimizeCss } from "carbon-preprocess-svelte";
|
||||
import { defineConfig } from "vite";
|
||||
|
||||
export default defineConfig({
|
||||
plugins: [sveltekit(), optimizeCss()],
|
||||
});
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
- [examples/rollup](examples/rollup/)
|
||||
|
|
@ -275,11 +252,3 @@ Refer to the [Contributing guidelines](CONTRIBUTING.md).
|
|||
|
||||
[npm]: https://img.shields.io/npm/v/carbon-components-svelte.svg?color=262626&style=for-the-badge
|
||||
[npm-url]: https://npmjs.com/package/carbon-components-svelte
|
||||
|
||||
## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry
|
||||
|
||||
This package uses IBM Telemetry to collect de-identified and anonymized metrics data in CI environments. By installing
|
||||
this package as a dependency you are agreeing to telemetry collection. To opt out, see
|
||||
[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
|
||||
For more information on the data being collected, please see the
|
||||
[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).
|
||||
|
|
|
|||
|
|
@ -1,325 +0,0 @@
|
|||
// This file is inlined from `carbon-components@10.47` as
|
||||
// Popover styles were removed since version 10.48.
|
||||
|
||||
//
|
||||
// Copyright IBM Corp. 2016, 2018
|
||||
//
|
||||
// This source code is licensed under the Apache-2.0 license found in the
|
||||
// LICENSE file in the root directory of this source tree.
|
||||
//
|
||||
|
||||
@import 'carbon-components/scss/globals/scss/vars';
|
||||
@import 'carbon-components/scss/globals/scss/helper-mixins';
|
||||
@import 'carbon-components/scss/globals/scss/vendor/@carbon/elements/scss/import-once/import-once';
|
||||
|
||||
/// Popover component
|
||||
/// @access private
|
||||
/// @group components
|
||||
@mixin popover {
|
||||
$popover-text-color: $text-01;
|
||||
$popover-caret-offset: 1rem;
|
||||
$popover-offset: 8px;
|
||||
|
||||
.#{$prefix}--popover {
|
||||
// Specify the distance between the popover and the trigger. This value must
|
||||
// have a unit otherwise the `calc()` expression will not work
|
||||
// stylelint-disable-next-line length-zero-no-unit
|
||||
--cds-popover-offset: 0rem;
|
||||
|
||||
// Specify the distance that the caret should be offset from the side of the
|
||||
// popover when not centered
|
||||
--cds-popover-caret-offset: 1rem;
|
||||
|
||||
position: absolute;
|
||||
z-index: z('floating');
|
||||
display: none;
|
||||
}
|
||||
|
||||
// We use a pseudo element inside of the popover to create a space between the
|
||||
// target and the popover. This helps in situations like tooltips where you do
|
||||
// not want the tooltip to disappear when the user moves from the target to
|
||||
// the popover.
|
||||
.#{$prefix}--popover::before {
|
||||
position: absolute;
|
||||
display: block;
|
||||
content: '';
|
||||
}
|
||||
|
||||
.#{$prefix}--popover--open {
|
||||
display: block;
|
||||
}
|
||||
|
||||
.#{$prefix}--popover-contents {
|
||||
@include box-shadow;
|
||||
|
||||
position: relative;
|
||||
width: max-content;
|
||||
max-width: rem(368px);
|
||||
background-color: $ui-01;
|
||||
border-radius: 2px;
|
||||
color: $popover-text-color;
|
||||
}
|
||||
|
||||
.#{$prefix}--popover--light .#{$prefix}--popover-contents {
|
||||
background-color: $ui-background;
|
||||
}
|
||||
|
||||
.#{$prefix}--popover--high-contrast .#{$prefix}--popover-contents {
|
||||
background-color: $inverse-02;
|
||||
color: $inverse-01;
|
||||
}
|
||||
|
||||
.#{$prefix}--popover--caret {
|
||||
--cds-popover-offset: 0.5rem;
|
||||
}
|
||||
|
||||
.#{$prefix}--popover--caret .#{$prefix}--popover-contents::before,
|
||||
.#{$prefix}--popover--caret .#{$prefix}--popover-contents::after {
|
||||
position: absolute;
|
||||
display: inline-block;
|
||||
width: rem(8px);
|
||||
height: rem(8px);
|
||||
background-color: inherit;
|
||||
content: '';
|
||||
}
|
||||
|
||||
.#{$prefix}--popover--caret .#{$prefix}--popover-contents::before {
|
||||
z-index: -1;
|
||||
box-shadow: 2px 2px 6px 0 rgba(0, 0, 0, 0.2);
|
||||
}
|
||||
|
||||
// The popover's tooltip is created by drawing two 8px x 8px boxes, one for
|
||||
// rendering the box-shadow that the popover content uses and another for
|
||||
// layering on top of this box to create an effect of a popover caret with a
|
||||
// box-shadow. The layer with the box-shadow is rendered behind the popover
|
||||
// content, while the other is rendered above of the popover content.
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// Bottom
|
||||
//-----------------------------------------------------------------------------
|
||||
.#{$prefix}--popover--bottom {
|
||||
bottom: 0;
|
||||
left: 50%;
|
||||
transform: translate(-50%, calc(100% + var(--cds-popover-offset)));
|
||||
}
|
||||
|
||||
@include place-caret(bottom) {
|
||||
top: 0;
|
||||
left: 50%;
|
||||
transform: translate(-50%, -50%) rotate(45deg);
|
||||
}
|
||||
|
||||
// Bottom left
|
||||
.#{$prefix}--popover--bottom-left {
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
transform: translateY(calc(100% + var(--cds-popover-offset)));
|
||||
}
|
||||
|
||||
@include place-caret(bottom-left) {
|
||||
top: 0;
|
||||
left: 0;
|
||||
transform: translate(var(--cds-popover-caret-offset), -50%) rotate(45deg);
|
||||
}
|
||||
|
||||
// Bottom right
|
||||
.#{$prefix}--popover--bottom-right {
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
transform: translateY(calc(100% + var(--cds-popover-offset)));
|
||||
}
|
||||
|
||||
@include place-caret(bottom-right) {
|
||||
top: 0;
|
||||
right: 0;
|
||||
transform: translate(calc(-1 * var(--cds-popover-caret-offset)), -50%)
|
||||
rotate(45deg);
|
||||
}
|
||||
|
||||
// Hover area
|
||||
.#{$prefix}--popover--bottom.#{$prefix}--popover::before,
|
||||
.#{$prefix}--popover--bottom-left.#{$prefix}--popover::before,
|
||||
.#{$prefix}--popover--bottom-right.#{$prefix}--popover::before {
|
||||
top: 0;
|
||||
right: 0;
|
||||
left: 0;
|
||||
height: var(--cds-popover-offset);
|
||||
transform: translateY(-100%);
|
||||
}
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// TOP
|
||||
//-----------------------------------------------------------------------------
|
||||
.#{$prefix}--popover--top {
|
||||
bottom: 100%;
|
||||
left: 50%;
|
||||
transform: translate(-50%, calc(-1 * var(--cds-popover-offset)));
|
||||
}
|
||||
|
||||
@include place-caret(top) {
|
||||
bottom: 0;
|
||||
left: 50%;
|
||||
transform: translate(-50%, 50%) rotate(45deg);
|
||||
}
|
||||
|
||||
// Top left
|
||||
.#{$prefix}--popover--top-left {
|
||||
bottom: 100%;
|
||||
left: 0;
|
||||
transform: translateY(calc(-1 * var(--cds-popover-offset)));
|
||||
}
|
||||
|
||||
@include place-caret(top-left) {
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
transform: translate(var(--cds-popover-caret-offset), 50%) rotate(45deg);
|
||||
}
|
||||
|
||||
// Top right
|
||||
.#{$prefix}--popover--top-right {
|
||||
right: 0;
|
||||
bottom: 100%;
|
||||
transform: translateY(calc(-1 * var(--cds-popover-offset)));
|
||||
}
|
||||
|
||||
@include place-caret(top-right) {
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
transform: translate(calc(-1 * var(--cds-popover-caret-offset)), 50%)
|
||||
rotate(45deg);
|
||||
}
|
||||
|
||||
// Hover area
|
||||
.#{$prefix}--popover--top.#{$prefix}--popover::before,
|
||||
.#{$prefix}--popover--top-left.#{$prefix}--popover::before,
|
||||
.#{$prefix}--popover--top-right.#{$prefix}--popover::before {
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
height: var(--cds-popover-offset);
|
||||
transform: translateY(100%);
|
||||
}
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// Right
|
||||
//-----------------------------------------------------------------------------
|
||||
.#{$prefix}--popover--right {
|
||||
top: 50%;
|
||||
left: 100%;
|
||||
transform: translate(var(--cds-popover-offset), -50%);
|
||||
}
|
||||
|
||||
@include place-caret(right) {
|
||||
top: 50%;
|
||||
left: 0;
|
||||
transform: translate(-50%, -50%) rotate(45deg);
|
||||
}
|
||||
|
||||
// Right top
|
||||
.#{$prefix}--popover--right-top {
|
||||
top: 0;
|
||||
left: 100%;
|
||||
transform: translateX($popover-offset);
|
||||
}
|
||||
|
||||
@include place-caret(right-top) {
|
||||
top: 0;
|
||||
left: 0;
|
||||
transform: translate(-50%, var(--cds-popover-caret-offset)) rotate(45deg);
|
||||
}
|
||||
|
||||
// Right bottom
|
||||
.#{$prefix}--popover--right-bottom {
|
||||
bottom: 0;
|
||||
left: 100%;
|
||||
transform: translateX(var(--cds-popover-offset));
|
||||
}
|
||||
|
||||
@include place-caret(right-bottom) {
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
transform: translate(-50%, calc(-1 * var(--cds-popover-caret-offset)))
|
||||
rotate(45deg);
|
||||
}
|
||||
|
||||
// Hover area
|
||||
.#{$prefix}--popover--right.#{$prefix}--popover::before,
|
||||
.#{$prefix}--popover--right-top.#{$prefix}--popover::before,
|
||||
.#{$prefix}--popover--right-bottom.#{$prefix}--popover::before {
|
||||
top: 0;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
width: var(--cds-popover-offset);
|
||||
transform: translateX(-100%);
|
||||
}
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// Left
|
||||
//-----------------------------------------------------------------------------
|
||||
.#{$prefix}--popover--left {
|
||||
top: 50%;
|
||||
right: 100%;
|
||||
transform: translate(calc(-1 * var(--cds-popover-offset)), -50%);
|
||||
}
|
||||
|
||||
@include place-caret(left) {
|
||||
top: 50%;
|
||||
right: 0;
|
||||
transform: translate(50%, -50%) rotate(45deg);
|
||||
}
|
||||
|
||||
// Left top
|
||||
.#{$prefix}--popover--left-top {
|
||||
top: 0;
|
||||
right: 100%;
|
||||
transform: translateX(calc(-1 * var(--cds-popover-offset)));
|
||||
}
|
||||
|
||||
@include place-caret(left-top) {
|
||||
top: 0;
|
||||
right: 0;
|
||||
transform: translate(50%, var(--cds-popover-caret-offset)) rotate(45deg);
|
||||
}
|
||||
|
||||
// Left bottom
|
||||
.#{$prefix}--popover--left-bottom {
|
||||
right: 100%;
|
||||
bottom: 0;
|
||||
transform: translateX(calc(-1 * var(--cds-popover-offset)));
|
||||
}
|
||||
|
||||
@include place-caret(left-bottom) {
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
transform: translate(50%, calc(-1 * var(--cds-popover-caret-offset)))
|
||||
rotate(45deg);
|
||||
}
|
||||
|
||||
// Hover area
|
||||
.#{$prefix}--popover--left.#{$prefix}--popover::before,
|
||||
.#{$prefix}--popover--left-top.#{$prefix}--popover::before,
|
||||
.#{$prefix}--popover--left-bottom.#{$prefix}--popover::before {
|
||||
top: 0;
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
width: var(--cds-popover-offset);
|
||||
transform: translateX(100%);
|
||||
}
|
||||
}
|
||||
|
||||
/// Helper for placing the caret inside a popover. The selectors here can get
|
||||
/// distracting in the main stylesheet, but ultimately they target the ::before
|
||||
/// and ::after pseudo-elements for the given direction. The @content block
|
||||
/// passed in should appropriately position the caret for the given direction.
|
||||
@mixin place-caret($direction) {
|
||||
.#{$prefix}--popover--caret.#{$prefix}--popover--#{$direction}
|
||||
.#{$prefix}--popover-contents::before,
|
||||
.#{$prefix}--popover--caret.#{$prefix}--popover--#{$direction}
|
||||
.#{$prefix}--popover-contents::after {
|
||||
@content;
|
||||
}
|
||||
}
|
||||
|
||||
@include exports('popover') {
|
||||
@include popover;
|
||||
}
|
||||
10
css/all.css
10
css/all.css
File diff suppressed because one or more lines are too long
92
css/all.scss
92
css/all.scss
|
|
@ -1,81 +1,35 @@
|
|||
// This is a recipe for dynamic, client-side theming
|
||||
// All Carbon themes are included (White, Gray 10, Gray 90, Gray 100)
|
||||
|
||||
$feature-flags: (
|
||||
// Custom CSS properties must be enabled to dynamically switch themes
|
||||
enable-css-custom-properties: true,
|
||||
ui-shell: true,
|
||||
grid-columns-16: true
|
||||
);
|
||||
|
||||
$css--font-face: true;
|
||||
$css--helpers: true;
|
||||
$css--body: true;
|
||||
$css--use-layer: true;
|
||||
$css--reset: true;
|
||||
$css--default-type: true;
|
||||
$css--plex: true;
|
||||
|
||||
// Use all Carbon themes
|
||||
@import "carbon-components/scss/globals/scss/vendor/@carbon/themes/scss";
|
||||
@import "carbon-components/scss/globals/scss/component-tokens";
|
||||
@import "carbon-components/src/components/tag/tag";
|
||||
@import "carbon-components/src/components/notification/inline-notification";
|
||||
@import "carbon-components/src/components/notification/toast-notification";
|
||||
@import "./popover";
|
||||
@use '@carbon/styles/scss/config' with (
|
||||
$use-akamai-cdn: true,
|
||||
$prefix: 'bx'
|
||||
);
|
||||
@use "@carbon/styles/scss/theme" as *;
|
||||
@use "@carbon/styles/scss/themes" as *;
|
||||
@use "@carbon/styles/scss/fonts";
|
||||
@use "@carbon/styles/scss/utilities" as *;
|
||||
|
||||
// The default theme is "white" (White)
|
||||
:root {
|
||||
@include carbon--theme($carbon--theme--white, true) {
|
||||
@include emit-component-tokens($tag-colors);
|
||||
@include emit-component-tokens($notification-colors);
|
||||
}
|
||||
@include theme($white);
|
||||
}
|
||||
|
||||
// Set the <html> theme attribute to "g10" to use the Gray 10 theme
|
||||
// <html theme="g10">
|
||||
:root[theme="g10"] {
|
||||
@include carbon--theme($carbon--theme--g10, true) {
|
||||
@include emit-component-tokens($tag-colors);
|
||||
@include emit-component-tokens($notification-colors);
|
||||
}
|
||||
[data-carbon-theme='g10'] {
|
||||
@include theme($g10);
|
||||
}
|
||||
|
||||
// Set the <html> theme attribute to "g80" to use the Gray 80 theme
|
||||
// <html theme="g80">
|
||||
:root[theme="g80"] {
|
||||
@include carbon--theme($carbon--theme--g80, true) {
|
||||
@include emit-component-tokens($tag-colors);
|
||||
@include emit-component-tokens($notification-colors);
|
||||
}
|
||||
[data-carbon-theme='g90'] {
|
||||
@include theme($g90);
|
||||
}
|
||||
|
||||
// Set the <html> theme attribute to "g90" to use the Gray 90 theme
|
||||
// <html theme="g90">
|
||||
:root[theme="g90"] {
|
||||
@include carbon--theme($carbon--theme--g90, true) {
|
||||
@include emit-component-tokens($tag-colors);
|
||||
@include emit-component-tokens($notification-colors);
|
||||
}
|
||||
[data-carbon-theme='g100'] {
|
||||
@include theme($g100);
|
||||
}
|
||||
|
||||
// Set the <html> theme attribute to "g100" to use the Gray 100 theme
|
||||
// <html theme="g100">
|
||||
:root[theme="g100"] {
|
||||
@include carbon--theme($carbon--theme--g100, true) {
|
||||
@include emit-component-tokens($tag-colors);
|
||||
@include emit-component-tokens($notification-colors);
|
||||
}
|
||||
@import "@carbon/styles/scss/reset";
|
||||
@import "@carbon/styles/scss/components";
|
||||
|
||||
.bx--text-truncate-end {
|
||||
@include text-truncate-end;
|
||||
}
|
||||
.bx--text-truncate-front {
|
||||
@include text-truncate-front;
|
||||
}
|
||||
|
||||
// Programmatically update the theme in JavaScript:
|
||||
// document.documentElement.setAttribute("theme", "g90");
|
||||
|
||||
@import "carbon-components/scss/globals/scss/_css--reset";
|
||||
@import "carbon-components/scss/globals/scss/_css--font-face";
|
||||
@import "carbon-components/scss/globals/scss/_css--helpers";
|
||||
@import "carbon-components/scss/globals/scss/_css--body";
|
||||
@import "carbon-components/scss/globals/grid/grid";
|
||||
|
||||
// Import all component styles
|
||||
@import "carbon-components/scss/globals/scss/styles";
|
||||
|
|
|
|||
10
css/g10.css
10
css/g10.css
File diff suppressed because one or more lines are too long
49
css/g10.scss
49
css/g10.scss
|
|
@ -1,34 +1,23 @@
|
|||
// Use the "g10" (Gray 10) Carbon theme
|
||||
@import "carbon-components/scss/globals/scss/vendor/@carbon/themes/scss";
|
||||
|
||||
$carbon--theme: $carbon--theme--g10;
|
||||
@include carbon--theme();
|
||||
|
||||
$feature-flags: (
|
||||
ui-shell: true,
|
||||
grid-columns-16: true
|
||||
// Use g10 theme
|
||||
@use '@carbon/styles/scss/config' with (
|
||||
$use-akamai-cdn: true,
|
||||
$prefix: 'bx'
|
||||
);
|
||||
@use "@carbon/styles/scss/theme" as *;
|
||||
@use "@carbon/styles/scss/themes" as *;
|
||||
@use "@carbon/styles/scss/fonts";
|
||||
@use "@carbon/styles/scss/utilities" as *;
|
||||
|
||||
$css--font-face: true;
|
||||
$css--helpers: true;
|
||||
$css--body: true;
|
||||
$css--use-layer: true;
|
||||
$css--reset: true;
|
||||
$css--default-type: true;
|
||||
$css--plex: true;
|
||||
:root {
|
||||
@include theme($g10);
|
||||
}
|
||||
|
||||
@import "carbon-components/scss/globals/scss/component-tokens";
|
||||
@import "carbon-components/src/components/tag/tag";
|
||||
@import "carbon-components/src/components/notification/inline-notification";
|
||||
@import "carbon-components/src/components/notification/toast-notification";
|
||||
@import "./popover";
|
||||
|
||||
@import "carbon-components/scss/globals/scss/_css--reset";
|
||||
@import "carbon-components/scss/globals/scss/_css--font-face";
|
||||
@import "carbon-components/scss/globals/scss/_css--helpers";
|
||||
@import "carbon-components/scss/globals/scss/_css--body";
|
||||
@import "carbon-components/scss/globals/grid/grid";
|
||||
|
||||
// Import all component styles
|
||||
@import "carbon-components/scss/globals/scss/styles";
|
||||
@import "@carbon/styles/scss/reset";
|
||||
@import "@carbon/styles/scss/components";
|
||||
|
||||
.bx--text-truncate-end {
|
||||
@include text-truncate-end;
|
||||
}
|
||||
.bx--text-truncate-front {
|
||||
@include text-truncate-front;
|
||||
}
|
||||
|
|
|
|||
10
css/g100.css
10
css/g100.css
File diff suppressed because one or more lines are too long
|
|
@ -1,33 +1,23 @@
|
|||
// Use the "g100" (Gray 100) Carbon theme
|
||||
@import "carbon-components/scss/globals/scss/vendor/@carbon/themes/scss";
|
||||
|
||||
$carbon--theme: $carbon--theme--g100;
|
||||
@include carbon--theme();
|
||||
|
||||
$feature-flags: (
|
||||
ui-shell: true,
|
||||
grid-columns-16: true
|
||||
// Use g10 theme
|
||||
@use '@carbon/styles/scss/config' with (
|
||||
$use-akamai-cdn: true,
|
||||
$prefix: 'bx'
|
||||
);
|
||||
@use "@carbon/styles/scss/theme" as *;
|
||||
@use "@carbon/styles/scss/themes" as *;
|
||||
@use "@carbon/styles/scss/fonts";
|
||||
@use "@carbon/styles/scss/utilities" as *;
|
||||
|
||||
$css--font-face: true;
|
||||
$css--helpers: true;
|
||||
$css--body: true;
|
||||
$css--use-layer: true;
|
||||
$css--reset: true;
|
||||
$css--default-type: true;
|
||||
$css--plex: true;
|
||||
:root {
|
||||
@include theme($g100);
|
||||
}
|
||||
|
||||
@import "carbon-components/scss/globals/scss/component-tokens";
|
||||
@import "carbon-components/src/components/tag/tag";
|
||||
@import "carbon-components/src/components/notification/inline-notification";
|
||||
@import "carbon-components/src/components/notification/toast-notification";
|
||||
@import "./popover";
|
||||
@import "@carbon/styles/scss/reset";
|
||||
@import "@carbon/styles/scss/components";
|
||||
|
||||
@import "carbon-components/scss/globals/scss/_css--reset";
|
||||
@import "carbon-components/scss/globals/scss/_css--font-face";
|
||||
@import "carbon-components/scss/globals/scss/_css--helpers";
|
||||
@import "carbon-components/scss/globals/scss/_css--body";
|
||||
@import "carbon-components/scss/globals/grid/grid";
|
||||
|
||||
// Import all component styles
|
||||
@import "carbon-components/scss/globals/scss/styles";
|
||||
.bx--text-truncate-end {
|
||||
@include text-truncate-end;
|
||||
}
|
||||
.bx--text-truncate-front {
|
||||
@include text-truncate-front;
|
||||
}
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
34
css/g80.scss
34
css/g80.scss
|
|
@ -1,34 +0,0 @@
|
|||
// Use the "g80" (Gray 80) Carbon theme
|
||||
@import "carbon-components/scss/globals/scss/vendor/@carbon/themes/scss";
|
||||
|
||||
$carbon--theme: $carbon--theme--g80;
|
||||
@include carbon--theme();
|
||||
|
||||
$feature-flags: (
|
||||
ui-shell: true,
|
||||
grid-columns-16: true
|
||||
);
|
||||
|
||||
$css--font-face: true;
|
||||
$css--helpers: true;
|
||||
$css--body: true;
|
||||
$css--use-layer: true;
|
||||
$css--reset: true;
|
||||
$css--default-type: true;
|
||||
$css--plex: true;
|
||||
|
||||
@import "carbon-components/scss/globals/scss/component-tokens";
|
||||
@import "carbon-components/src/components/tag/tag";
|
||||
@import "carbon-components/src/components/notification/inline-notification";
|
||||
@import "carbon-components/src/components/notification/toast-notification";
|
||||
@import "./popover";
|
||||
|
||||
@import "carbon-components/scss/globals/scss/_css--reset";
|
||||
@import "carbon-components/scss/globals/scss/_css--font-face";
|
||||
@import "carbon-components/scss/globals/scss/_css--helpers";
|
||||
@import "carbon-components/scss/globals/scss/_css--body";
|
||||
@import "carbon-components/scss/globals/grid/grid";
|
||||
|
||||
// Import all component styles
|
||||
@import "carbon-components/scss/globals/scss/styles";
|
||||
|
||||
10
css/g90.css
10
css/g90.css
File diff suppressed because one or more lines are too long
48
css/g90.scss
48
css/g90.scss
|
|
@ -1,33 +1,23 @@
|
|||
// Use the "g90" (Gray 90) Carbon theme
|
||||
@import "carbon-components/scss/globals/scss/vendor/@carbon/themes/scss";
|
||||
|
||||
$carbon--theme: $carbon--theme--g90;
|
||||
@include carbon--theme();
|
||||
|
||||
$feature-flags: (
|
||||
ui-shell: true,
|
||||
grid-columns-16: true
|
||||
// Use g10 theme
|
||||
@use '@carbon/styles/scss/config' with (
|
||||
$use-akamai-cdn: true,
|
||||
$prefix: 'bx'
|
||||
);
|
||||
@use "@carbon/styles/scss/theme" as *;
|
||||
@use "@carbon/styles/scss/themes" as *;
|
||||
@use "@carbon/styles/scss/fonts";
|
||||
@use "@carbon/styles/scss/utilities" as *;
|
||||
|
||||
$css--font-face: true;
|
||||
$css--helpers: true;
|
||||
$css--body: true;
|
||||
$css--use-layer: true;
|
||||
$css--reset: true;
|
||||
$css--default-type: true;
|
||||
$css--plex: true;
|
||||
:root {
|
||||
@include theme($g90);
|
||||
}
|
||||
|
||||
@import "carbon-components/scss/globals/scss/component-tokens";
|
||||
@import "carbon-components/src/components/tag/tag";
|
||||
@import "carbon-components/src/components/notification/inline-notification";
|
||||
@import "carbon-components/src/components/notification/toast-notification";
|
||||
@import "./popover";
|
||||
@import "@carbon/styles/scss/reset";
|
||||
@import "@carbon/styles/scss/components";
|
||||
|
||||
@import "carbon-components/scss/globals/scss/_css--reset";
|
||||
@import "carbon-components/scss/globals/scss/_css--font-face";
|
||||
@import "carbon-components/scss/globals/scss/_css--helpers";
|
||||
@import "carbon-components/scss/globals/scss/_css--body";
|
||||
@import "carbon-components/scss/globals/grid/grid";
|
||||
|
||||
// Import all component styles
|
||||
@import "carbon-components/scss/globals/scss/styles";
|
||||
.bx--text-truncate-end {
|
||||
@include text-truncate-end;
|
||||
}
|
||||
.bx--text-truncate-front {
|
||||
@include text-truncate-front;
|
||||
}
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,33 +0,0 @@
|
|||
// Use the "white" (White) Carbon theme
|
||||
@import "carbon-components/scss/globals/scss/vendor/@carbon/themes/scss";
|
||||
|
||||
$carbon--theme: $carbon--theme--white;
|
||||
@include carbon--theme();
|
||||
|
||||
$feature-flags: (
|
||||
ui-shell: true,
|
||||
grid-columns-16: true
|
||||
);
|
||||
|
||||
$css--font-face: true;
|
||||
$css--helpers: true;
|
||||
$css--body: true;
|
||||
$css--use-layer: true;
|
||||
$css--reset: true;
|
||||
$css--default-type: true;
|
||||
$css--plex: true;
|
||||
|
||||
@import "carbon-components/scss/globals/scss/component-tokens";
|
||||
@import "carbon-components/src/components/tag/tag";
|
||||
@import "carbon-components/src/components/notification/inline-notification";
|
||||
@import "carbon-components/src/components/notification/toast-notification";
|
||||
@import "./popover";
|
||||
|
||||
@import "carbon-components/scss/globals/scss/_css--reset";
|
||||
@import "carbon-components/scss/globals/scss/_css--font-face";
|
||||
@import "carbon-components/scss/globals/scss/_css--helpers";
|
||||
@import "carbon-components/scss/globals/scss/_css--body";
|
||||
@import "carbon-components/scss/globals/grid/grid";
|
||||
|
||||
// Import all component styles
|
||||
@import "carbon-components/scss/globals/scss/styles";
|
||||
|
|
@ -3,20 +3,15 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<link rel="icon" href="/favicon.ico" />
|
||||
<link rel="canonical" href="https://svelte.carbondesignsystem.com/" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="description" content="Svelte implementation of the Carbon Design System" />
|
||||
<title>Carbon Components Svelte</title>
|
||||
<script>
|
||||
try {
|
||||
const theme = localStorage.getItem("theme");
|
||||
|
||||
if (["white", "g10", "g80", "g90", "g100"].includes(theme)) {
|
||||
if (["white", "g10", "g90", "g100"].includes(theme)) {
|
||||
document.documentElement.setAttribute("theme", theme);
|
||||
document.documentElement.style.setProperty(
|
||||
"color-scheme",
|
||||
["white", "g10"].includes(theme) ? "light" : "dark"
|
||||
);
|
||||
document.documentElement.style.setProperty("color-scheme", ["white", "g10"].includes(theme) ? "light" : "dark");
|
||||
}
|
||||
} catch (e) {}
|
||||
</script>
|
||||
|
|
|
|||
2057
docs/package-lock.json
generated
2057
docs/package-lock.json
generated
File diff suppressed because it is too large
Load diff
|
|
@ -10,22 +10,23 @@
|
|||
"build:svite": "vite build"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@ibm/plex": "^6.1.1",
|
||||
"@sveltech/routify": "^1.9.10",
|
||||
"@sveltejs/vite-plugin-svelte": "^3.1.2",
|
||||
"carbon-components-svelte": "file:..",
|
||||
"carbon-icons-svelte": "^13.3.0",
|
||||
"@sveltejs/vite-plugin-svelte": "^3.0.1",
|
||||
"carbon-components-svelte": "../",
|
||||
"carbon-icons-svelte": "^12.4.1",
|
||||
"clipboard-copy": "^4.0.1",
|
||||
"cross-env": "^7.0.3",
|
||||
"mdsvex": "^0.12.3",
|
||||
"minisearch": "^7.1.0",
|
||||
"mdsvex": "^0.11.0",
|
||||
"minisearch": "^6.2.0",
|
||||
"npm-run-all": "^4.1.5",
|
||||
"prettier": "^2.8.8",
|
||||
"prettier-plugin-svelte": "^2.10.1",
|
||||
"prism-svelte": "^0.5.0",
|
||||
"prismjs": "^1.30.0",
|
||||
"remark-slug": "^6.1.0",
|
||||
"svelte": "^4.2.19",
|
||||
"vite": "^5.4.19"
|
||||
"prettier": "^2.7.1",
|
||||
"prettier-plugin-svelte": "^2.7.0",
|
||||
"prism-svelte": "^0.4.7",
|
||||
"prismjs": "^1.28.0",
|
||||
"remark-slug": "^6.0.0",
|
||||
"svelte": "^4.2.8",
|
||||
"vite": "^5.0.10"
|
||||
},
|
||||
"routify": {
|
||||
"routifyDir": ".routify",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
// @ts-check
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import fs from "fs";
|
||||
import path from "path";
|
||||
import githubSlugger from "github-slugger";
|
||||
|
||||
const { slug } = githubSlugger;
|
||||
|
|
|
|||
|
|
@ -3,4 +3,4 @@
|
|||
import { routes } from "../.routify/routes";
|
||||
</script>
|
||||
|
||||
<Router {routes} />
|
||||
<Router routes="{routes}" />
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -7,7 +7,6 @@
|
|||
typedefs: [],
|
||||
};
|
||||
|
||||
import { onMount } from "svelte";
|
||||
import {
|
||||
OutboundLink,
|
||||
StructuredList,
|
||||
|
|
@ -18,16 +17,10 @@
|
|||
UnorderedList,
|
||||
ListItem,
|
||||
Tag,
|
||||
CodeSnippet,
|
||||
} from "carbon-components-svelte";
|
||||
import InlineSnippet from "./InlineSnippet.svelte";
|
||||
|
||||
let AsyncPreviewTypeScript;
|
||||
|
||||
onMount(async () => {
|
||||
AsyncPreviewTypeScript = (await import("./PreviewTypeScript.svelte"))
|
||||
.default;
|
||||
});
|
||||
|
||||
const mdn_api = "https://developer.mozilla.org/en-US/docs/Web/API/";
|
||||
const typeMap = {
|
||||
string: "string",
|
||||
|
|
@ -39,16 +32,16 @@
|
|||
|
||||
$: source = `https://github.com/carbon-design-system/carbon-components-svelte/tree/master/${component.filePath}`;
|
||||
$: forwarded_events = component.events.filter(
|
||||
(event) => event.type === "forwarded",
|
||||
(event) => event.type === "forwarded"
|
||||
);
|
||||
$: dispatched_events = component.events.filter(
|
||||
(event) => event.type === "dispatched",
|
||||
(event) => event.type === "dispatched"
|
||||
);
|
||||
</script>
|
||||
|
||||
<p style="margin-bottom: var(--cds-layout-02)">
|
||||
<p style="margin-bottom: var(--bx-spacing-06)">
|
||||
Source code:
|
||||
<OutboundLink size="lg" inline href={source}>
|
||||
<OutboundLink size="lg" inline href="{source}">
|
||||
{component.filePath}
|
||||
</OutboundLink>
|
||||
</p>
|
||||
|
|
@ -62,29 +55,20 @@
|
|||
<StructuredListRow head>
|
||||
<StructuredListCell head>Prop name</StructuredListCell>
|
||||
<StructuredListCell head>Type</StructuredListCell>
|
||||
<StructuredListCell head noWrap>Default value</StructuredListCell>
|
||||
<StructuredListCell head>Description</StructuredListCell>
|
||||
</StructuredListRow>
|
||||
</StructuredListHead>
|
||||
<StructuredListBody>
|
||||
{#each component.props.sort((a, b) => {
|
||||
// Sort props so required props are listed first, then reactive props.
|
||||
|
||||
if (a.isRequired !== b.isRequired) {
|
||||
return b.isRequired ? 1 : -1;
|
||||
}
|
||||
|
||||
if (a.reactive !== b.reactive) {
|
||||
return b.reactive ? 1 : -1;
|
||||
}
|
||||
|
||||
return 0;
|
||||
if (a.reactive > b.reactive) return -1;
|
||||
}) as prop (prop.name)}
|
||||
<StructuredListRow>
|
||||
<StructuredListCell noWrap>
|
||||
<InlineSnippet code={prop.name} />
|
||||
<InlineSnippet code="{prop.name}" />
|
||||
{#if prop.reactive}
|
||||
<div
|
||||
style="white-space: nowrap; margin-top: var(--cds-spacing-03); margin-bottom: var(--cds-spacing-{prop.isRequired
|
||||
style="white-space: nowrap; margin-top: var(--bx-spacing-03); margin-bottom: var(--bx-spacing-{prop.isRequired
|
||||
? '01'
|
||||
: '03'})"
|
||||
>
|
||||
|
|
@ -111,29 +95,18 @@
|
|||
{type}
|
||||
</OutboundLink>
|
||||
{:else if type in typeMap}
|
||||
<div
|
||||
style="display: inline-flex; max-width: 220px; word-break: break-word;"
|
||||
>
|
||||
<svelte:component
|
||||
this={AsyncPreviewTypeScript}
|
||||
type="inline"
|
||||
code={typeMap[type]}
|
||||
/>
|
||||
</div>
|
||||
<code class="code-01">{typeMap[type]}</code>
|
||||
{:else if type.startsWith("(")}
|
||||
<code class="code-01">{type}</code>
|
||||
{:else}
|
||||
<div
|
||||
style="display: inline-flex; max-width: 220px; word-break: break-word;"
|
||||
>
|
||||
<svelte:component
|
||||
this={AsyncPreviewTypeScript}
|
||||
type="inline"
|
||||
code={type}
|
||||
/>
|
||||
</div>
|
||||
<InlineSnippet code="{type}" />
|
||||
{/if}
|
||||
</div>
|
||||
{/each}
|
||||
</StructuredListCell>
|
||||
<StructuredListCell
|
||||
><code class="code-01">{prop.value}</code></StructuredListCell
|
||||
>
|
||||
<StructuredListCell>
|
||||
{#if prop.description}
|
||||
{#each prop.description.split("\n") as line}
|
||||
|
|
@ -144,27 +117,9 @@
|
|||
.replace(/`(.*?)`/g, "<code>$1</code>")}.
|
||||
</div>
|
||||
{/each}
|
||||
{:else}
|
||||
<div class="description">No description available.</div>
|
||||
{/if}
|
||||
<div
|
||||
style:margin-top="var(--cds-layout-02)"
|
||||
style:margin-bottom="var(--cds-spacing-03)"
|
||||
>
|
||||
<strong>Default value</strong>
|
||||
</div>
|
||||
<div
|
||||
style:margin-bottom="var(--cds-layout-01)"
|
||||
style:max-width="85%"
|
||||
>
|
||||
{#if prop.value === undefined}
|
||||
<em>undefined</em>
|
||||
{:else}
|
||||
<svelte:component
|
||||
this={AsyncPreviewTypeScript}
|
||||
type={/\n/.test(prop.value) ? "multi" : "inline"}
|
||||
code={prop.value}
|
||||
/>
|
||||
{/if}
|
||||
</div>
|
||||
</StructuredListCell>
|
||||
</StructuredListRow>
|
||||
{/each}
|
||||
|
|
@ -178,42 +133,23 @@
|
|||
<h2 id="typedefs">Typedefs</h2>
|
||||
|
||||
{#if component.typedefs.length > 0}
|
||||
<div class="my-layout-01-03">
|
||||
<svelte:component
|
||||
this={AsyncPreviewTypeScript}
|
||||
code={component.typedefs.map((t) => t.ts).join("\n")}
|
||||
/>
|
||||
</div>
|
||||
<CodeSnippet
|
||||
style="margin-top: var(--bx-spacing-08)"
|
||||
class="my-layout-01-03"
|
||||
type="multi"
|
||||
code="{component.typedefs.map((t) => t.ts).join(';\n\n')};"
|
||||
/>
|
||||
{:else}
|
||||
<p class="my-layout-01-03">No typedefs.</p>
|
||||
{/if}
|
||||
|
||||
<h2 id="slots">Slots</h2>
|
||||
{#if component.slots.length > 0}
|
||||
<StructuredList class="my-layout-01-03">
|
||||
<StructuredListHead>
|
||||
<StructuredListRow>
|
||||
<StructuredListCell>Slot name</StructuredListCell>
|
||||
<StructuredListCell>Slot detail</StructuredListCell>
|
||||
</StructuredListRow>
|
||||
</StructuredListHead>
|
||||
<StructuredListBody>
|
||||
{#each component.slots as slot (slot.name)}
|
||||
<StructuredListRow>
|
||||
<StructuredListCell>
|
||||
<strong>{slot.default ? "default" : slot.name}</strong>
|
||||
</StructuredListCell>
|
||||
<StructuredListCell>
|
||||
<svelte:component
|
||||
this={AsyncPreviewTypeScript}
|
||||
type={/\n/.test(slot.slot_props) ? "multi" : "inline"}
|
||||
code={slot.slot_props}
|
||||
/>
|
||||
</StructuredListCell>
|
||||
</StructuredListRow>
|
||||
{/each}
|
||||
</StructuredListBody>
|
||||
</StructuredList>
|
||||
<UnorderedList class="my-layout-01-03">
|
||||
{#each component.slots as slot (slot.name)}
|
||||
<ListItem>{slot.default ? "default" : slot.name}</ListItem>
|
||||
{/each}
|
||||
</UnorderedList>
|
||||
{:else}
|
||||
<p class="my-layout-01-03">No slots.</p>
|
||||
{/if}
|
||||
|
|
@ -237,7 +173,7 @@
|
|||
<StructuredListHead>
|
||||
<StructuredListRow>
|
||||
<StructuredListCell>Event name</StructuredListCell>
|
||||
<StructuredListCell>Event detail</StructuredListCell>
|
||||
<StructuredListCell><code>event.detail</code> type</StructuredListCell>
|
||||
{#if hasDescription}
|
||||
<StructuredListCell>Description</StructuredListCell>
|
||||
{/if}
|
||||
|
|
@ -250,11 +186,7 @@
|
|||
<strong>on:{event.name}</strong>
|
||||
</StructuredListCell>
|
||||
<StructuredListCell>
|
||||
<svelte:component
|
||||
this={AsyncPreviewTypeScript}
|
||||
type={/\n/.test(event.detail) ? "multi" : "inline"}
|
||||
code={event.detail}
|
||||
/>
|
||||
<code>{event.detail}</code>
|
||||
</StructuredListCell>
|
||||
<StructuredListCell>
|
||||
{event.description ?? ""}
|
||||
|
|
@ -284,15 +216,14 @@
|
|||
|
||||
<style>
|
||||
.description {
|
||||
margin-bottom: var(--cds-spacing-04);
|
||||
width: 80%;
|
||||
margin-bottom: var(--bx-spacing-04);
|
||||
}
|
||||
|
||||
.cell {
|
||||
position: relative;
|
||||
z-index: 9;
|
||||
min-height: 1.25rem;
|
||||
margin-bottom: var(--cds-spacing-02);
|
||||
margin-bottom: var(--bx-spacing-02);
|
||||
}
|
||||
|
||||
.overflow {
|
||||
|
|
@ -300,24 +231,20 @@
|
|||
}
|
||||
|
||||
:global(.my-layout-01-03) {
|
||||
margin-top: var(--cds-layout-01);
|
||||
margin-bottom: var(--cds-layout-03);
|
||||
margin-top: var(--bx-spacing-05);
|
||||
margin-bottom: var(--bx-spacing-07);
|
||||
}
|
||||
|
||||
:global(.overflow .bx--structured-list) {
|
||||
margin-top: var(--cds-layout-01);
|
||||
margin-bottom: var(--cds-layout-04);
|
||||
margin-top: var(--bx-spacing-05);
|
||||
margin-bottom: var(--bx-spacing-09);
|
||||
}
|
||||
|
||||
code {
|
||||
word-break: break-word;
|
||||
}
|
||||
|
||||
:global(
|
||||
.cell .bx--snippet--inline code,
|
||||
.cell .bx--snippet--single pre,
|
||||
.bx--snippet--inline code
|
||||
) {
|
||||
:global(.cell .bx--snippet--inline code, .bx--snippet--single pre) {
|
||||
white-space: pre-wrap !important;
|
||||
}
|
||||
</style>
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@
|
|||
</script>
|
||||
|
||||
<div>
|
||||
<CodeSnippet {code} type="inline" copy={(text) => copy(text)} />
|
||||
<CodeSnippet code="{code}" type="inline" copy="{(text) => copy(text)}" />
|
||||
</div>
|
||||
|
||||
<style>
|
||||
div {
|
||||
margin-bottom: var(--cds-spacing-03);
|
||||
margin-bottom: var(--bx-spacing-03);
|
||||
}
|
||||
</style>
|
||||
|
|
|
|||
|
|
@ -16,9 +16,7 @@
|
|||
<div class="preview">
|
||||
{#if framed}
|
||||
<div class="framed-header">
|
||||
<div
|
||||
style="margin-left: var(--cds-spacing-05); color: var(--cds-text-02)"
|
||||
>
|
||||
<div style="margin-left: var(--bx-spacing-05); color: var(--bx-text-02)">
|
||||
Content loaded in an iframe
|
||||
</div>
|
||||
<Button
|
||||
|
|
@ -26,23 +24,22 @@
|
|||
kind="ghost"
|
||||
target="_blank"
|
||||
size="field"
|
||||
href={themedSrcUrl}
|
||||
icon={Launch}
|
||||
href="{themedSrcUrl}"
|
||||
icon="{Launch}"
|
||||
>
|
||||
Open in new tab
|
||||
</Button>
|
||||
</div>
|
||||
{/if}
|
||||
<div class="preview-viewer" class:framed>
|
||||
<div class="preview-viewer" class:framed="{framed}">
|
||||
{#if framed}
|
||||
<iframe loading="lazy" title={src.split("/").pop()} src={themedSrcUrl}
|
||||
></iframe>
|
||||
<iframe title="{src.split('/').pop()}" src="{themedSrcUrl}"></iframe>
|
||||
{:else}
|
||||
<slot />
|
||||
{/if}
|
||||
</div>
|
||||
<div class="code-override">
|
||||
<CodeSnippet type="multi" code={codeRaw} copy={(text) => copy(text)}>
|
||||
<CodeSnippet type="multi" code="{codeRaw}" copy="{(text) => copy(text)}">
|
||||
{@html code}
|
||||
</CodeSnippet>
|
||||
</div>
|
||||
|
|
@ -50,10 +47,10 @@
|
|||
|
||||
<style>
|
||||
.preview {
|
||||
margin-bottom: var(--cds-layout-04);
|
||||
margin-bottom: var(--bx-spacing-09);
|
||||
margin-left: -1rem;
|
||||
margin-right: -1rem;
|
||||
max-width: 80rem;
|
||||
max-width: 66rem;
|
||||
}
|
||||
|
||||
.code-override {
|
||||
|
|
@ -61,26 +58,20 @@
|
|||
}
|
||||
|
||||
.preview-viewer {
|
||||
border: 1px solid var(--cds-ui-03);
|
||||
border: 1px solid var(--bx-ui-03);
|
||||
border-bottom: 0;
|
||||
position: relative;
|
||||
z-index: 9999;
|
||||
}
|
||||
|
||||
.preview-viewer:not(.framed) {
|
||||
padding: var(--cds-spacing-06) var(--cds-spacing-05);
|
||||
padding: var(--bx-spacing-06) var(--bx-spacing-05);
|
||||
}
|
||||
|
||||
.preview-viewer.framed {
|
||||
min-height: 20rem;
|
||||
}
|
||||
|
||||
@media (min-width: 1920px) {
|
||||
.preview-viewer.framed {
|
||||
min-height: 32rem;
|
||||
}
|
||||
}
|
||||
|
||||
.framed-header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
|
|
|
|||
|
|
@ -1,29 +0,0 @@
|
|||
<script>
|
||||
export let code = "";
|
||||
export let type = "multi";
|
||||
|
||||
import { CodeSnippet } from "carbon-components-svelte";
|
||||
import { highlight } from "prismjs";
|
||||
import "prismjs/components/prism-typescript";
|
||||
import copy from "clipboard-copy";
|
||||
|
||||
$: highlightedCode = highlight(
|
||||
code,
|
||||
Prism.languages.typescript,
|
||||
"typescript",
|
||||
);
|
||||
</script>
|
||||
|
||||
{#if type === "multi"}
|
||||
<div class="code-override">
|
||||
<CodeSnippet type="multi" {code} {copy}>
|
||||
{@html highlightedCode}
|
||||
</CodeSnippet>
|
||||
</div>
|
||||
{/if}
|
||||
|
||||
{#if type === "inline"}
|
||||
<CodeSnippet type="inline" class="code-override-inline" {code} {copy}>
|
||||
{@html highlightedCode}
|
||||
</CodeSnippet>
|
||||
{/if}
|
||||
|
|
@ -12,13 +12,17 @@
|
|||
$: tileComponent = href ? ClickableTile : Tile;
|
||||
</script>
|
||||
|
||||
<div class="card-wrapper" class:borderRight class:borderBottom>
|
||||
<div
|
||||
class="card-wrapper"
|
||||
class:borderRight="{borderRight}"
|
||||
class:borderBottom="{borderBottom}"
|
||||
>
|
||||
<AspectRatio>
|
||||
<svelte:component
|
||||
this={tileComponent}
|
||||
{href}
|
||||
this="{tileComponent}"
|
||||
href="{href}"
|
||||
{...$$restProps}
|
||||
style="height: 100%;"
|
||||
style="height: 100%; width: 100%; position: absolute;"
|
||||
>
|
||||
<div class="card">
|
||||
<div>
|
||||
|
|
@ -29,11 +33,11 @@
|
|||
</div>
|
||||
<div class="card-footer">
|
||||
<svelte:component
|
||||
this={LogoGithub}
|
||||
size={32}
|
||||
style="fill: var(--cds-icon-01)"
|
||||
this="{LogoGithub}"
|
||||
size="{32}"
|
||||
style="fill: var(--bx-icon-01)"
|
||||
/>
|
||||
<Launch size={20} style="fill: var(--cds-icon-01)" />
|
||||
<Launch size="{20}" style="fill: var(--bx-icon-01)" />
|
||||
</div>
|
||||
</div>
|
||||
</svelte:component>
|
||||
|
|
@ -47,11 +51,11 @@
|
|||
}
|
||||
|
||||
.borderRight {
|
||||
border-right: 1px solid var(--cds-ui-03);
|
||||
border-right: 1px solid var(--bx-ui-03);
|
||||
}
|
||||
|
||||
.borderBottom {
|
||||
border-bottom: 1px solid var(--cds-ui-03);
|
||||
border-bottom: 1px solid var(--bx-ui-03);
|
||||
}
|
||||
|
||||
.card {
|
||||
|
|
@ -68,19 +72,19 @@
|
|||
}
|
||||
|
||||
.title {
|
||||
margin-top: calc(-1 * var(--cds-spacing-02));
|
||||
margin-bottom: var(--cds-spacing-01);
|
||||
margin-top: calc(-1 * var(--bx-spacing-02));
|
||||
margin-bottom: var(--bx-spacing-01);
|
||||
}
|
||||
|
||||
.subtitle {
|
||||
color: var(--cds-text-02);
|
||||
color: var(--bx-text-02);
|
||||
}
|
||||
|
||||
@media (max-width: 671px) {
|
||||
.card-wrapper,
|
||||
.borderRight {
|
||||
border-right: 0;
|
||||
border-bottom: 1px solid var(--cds-ui-03);
|
||||
border-bottom: 1px solid var(--bx-ui-03);
|
||||
}
|
||||
}
|
||||
</style>
|
||||
|
|
|
|||
|
|
@ -1,20 +1,11 @@
|
|||
html[theme="g90"] .code-override {
|
||||
border: 1px solid var(--cds-ui-03);
|
||||
border: 1px solid var(--bx-border-subtle-01);
|
||||
}
|
||||
|
||||
.prose > pre,
|
||||
.code-override .bx--snippet {
|
||||
/** Docs code snippet is always dark mode */
|
||||
color-scheme: dark;
|
||||
max-width: none;
|
||||
}
|
||||
|
||||
.prose > pre {
|
||||
padding: 1rem;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
.prose > pre,
|
||||
.code-override .bx--copy-btn,
|
||||
.code-override .bx--snippet,
|
||||
.code-override button.bx--btn.bx--snippet-btn--expand {
|
||||
|
|
@ -31,11 +22,10 @@ html[theme="g90"] .code-override {
|
|||
fill: #f4f4f4;
|
||||
}
|
||||
|
||||
.prose > pre,
|
||||
.code-override .bx--snippet-container pre {
|
||||
font-size: var(--cds-code-02-font-size);
|
||||
line-height: var(--cds-code-02-line-height);
|
||||
letter-spacing: var(--cds-code-02-letter-spacing);
|
||||
font-size: var(--bx-code-02-font-size);
|
||||
line-height: var(--bx-code-02-line-height);
|
||||
letter-spacing: var(--bx-code-02-letter-spacing);
|
||||
cursor: text;
|
||||
}
|
||||
|
||||
|
|
@ -53,18 +43,6 @@ html[theme="g90"] .code-override {
|
|||
color: #6ea6ff;
|
||||
}
|
||||
|
||||
/* Override syntax highlighting for light theme inline code .*/
|
||||
[theme="white"] .code-override-inline .token,
|
||||
[theme="g10"] .code-override-inline .token {
|
||||
color: var(--cds-text-01, #161616);
|
||||
}
|
||||
|
||||
/** Gray 80 is the "lighted" dark theme. Ensure the background is dark. */
|
||||
[theme="g80"] .code-override-inline {
|
||||
background-color: #262626;
|
||||
}
|
||||
|
||||
.token.builtin,
|
||||
.token.attr-name {
|
||||
color: #3ddbd9; /* teal 30 */
|
||||
}
|
||||
|
|
@ -140,7 +118,7 @@ html[theme="g90"] .code-override {
|
|||
}
|
||||
|
||||
.prose .toc {
|
||||
margin-bottom: var(--cds-layout-01);
|
||||
margin-bottom: var(--bx-spacing-05);
|
||||
}
|
||||
|
||||
.table {
|
||||
|
|
@ -148,9 +126,9 @@ html[theme="g90"] .code-override {
|
|||
max-height: calc(100vh - 3rem);
|
||||
top: 3rem;
|
||||
margin-top: -3rem;
|
||||
padding-top: var(--cds-spacing-05);
|
||||
padding-bottom: var(--cds-spacing-05);
|
||||
padding-left: var(--cds-spacing-08);
|
||||
padding-top: var(--bx-spacing-05);
|
||||
padding-bottom: var(--bx-spacing-05);
|
||||
padding-left: var(--bx-spacing-08);
|
||||
overflow-y: auto;
|
||||
}
|
||||
|
||||
|
|
@ -171,7 +149,7 @@ html[theme="g90"] .code-override {
|
|||
|
||||
.preview-viewer > .bx--aspect-ratio,
|
||||
.preview-viewer [data-outline] {
|
||||
outline: 1px solid var(--cds-interactive-04);
|
||||
outline: 1px solid var(--bx-interactive);
|
||||
}
|
||||
|
||||
[data-outline] {
|
||||
|
|
@ -179,7 +157,7 @@ html[theme="g90"] .code-override {
|
|||
}
|
||||
|
||||
[data-outline] ~ [data-outline] {
|
||||
margin-top: var(--cds-spacing-08);
|
||||
margin-top: var(--bx-spacing-08);
|
||||
}
|
||||
|
||||
#select-theme {
|
||||
|
|
@ -191,46 +169,46 @@ html[theme="g90"] .code-override {
|
|||
}
|
||||
|
||||
.prose .toc {
|
||||
margin-bottom: var(--cds-layout-01);
|
||||
margin-bottom: var(--bx-spacing-05);
|
||||
}
|
||||
|
||||
.code-01 {
|
||||
font-size: var(--cds-code-01-font-size);
|
||||
font-weight: var(--cds-code-01-font-weight);
|
||||
letter-spacing: var(--cds-code-01-letter-spacing);
|
||||
line-height: var(--cds-code-01-line-height);
|
||||
font-size: var(--bx-code-01-font-size);
|
||||
font-weight: var(--bx-code-01-font-weight);
|
||||
letter-spacing: var(--bx-code-01-letter-spacing);
|
||||
line-height: var(--bx-code-01-line-height);
|
||||
}
|
||||
|
||||
.body-short-01 {
|
||||
font-size: var(--cds-body-short-01-font-size);
|
||||
font-weight: var(--cds-body-short-01-font-weight);
|
||||
letter-spacing: var(--cds-body-short-01-letter-spacing);
|
||||
line-height: var(--cds-body-short-01-line-height);
|
||||
.body-compact-01 {
|
||||
font-size: var(--bx-body-compact-01-font-size);
|
||||
font-weight: var(--bx-body-compact-01-font-weight);
|
||||
letter-spacing: var(--bx-body-compact-01-letter-spacing);
|
||||
line-height: var(--bx-body-compact-01-line-height);
|
||||
}
|
||||
|
||||
.bx--col > h1 {
|
||||
font-size: var(--cds-expressive-heading-05-font-size);
|
||||
font-weight: var(--cds-expressive-heading-05-font-weight);
|
||||
letter-spacing: var(--cds-expressive-heading-05-letter-spacing);
|
||||
line-height: var(--cds-expressive-heading-05-line-height);
|
||||
margin-bottom: var(--cds-layout-01);
|
||||
font-size: var(--bx-fluid-heading-05-font-size);
|
||||
font-weight: var(--bx-fluid-heading-05-font-weight);
|
||||
letter-spacing: var(--bx-fluid-heading-05-letter-spacing);
|
||||
line-height: var(--bx-fluid-heading-05-line-height);
|
||||
margin-bottom: var(--bx-spacing-05);
|
||||
}
|
||||
|
||||
.big-paragraph {
|
||||
font-size: var(--cds-expressive-heading-03-font-size);
|
||||
font-weight: var(--cds-expressive-heading-03-font-weight);
|
||||
letter-spacing: var(--cds-expressive-heading-03-letter-spacing);
|
||||
line-height: var(--cds-expressive-heading-03-line-height);
|
||||
margin-top: var(--cds-layout-03);
|
||||
margin-bottom: var(--cds-layout-06);
|
||||
font-size: var(--bx-fluid-heading-03-font-size);
|
||||
font-weight: var(--bx-fluid-heading-03-font-weight);
|
||||
letter-spacing: var(--bx-fluid-heading-03-letter-spacing);
|
||||
line-height: var(--bx-fluid-heading-03-line-height);
|
||||
margin-top: var(--bx-spacing-07);
|
||||
margin-bottom: var(--bx-spacing-12);
|
||||
}
|
||||
|
||||
.big-link,
|
||||
.bx--col > .big-paragraph > code {
|
||||
font-size: var(--cds-expressive-heading-03-font-size);
|
||||
font-weight: var(--cds-expressive-heading-03-font-weight);
|
||||
letter-spacing: var(--cds-expressive-heading-03-letter-spacing);
|
||||
line-height: var(--cds-expressive-heading-03-line-height);
|
||||
font-size: var(--bx-fluid-heading-03-font-size);
|
||||
font-weight: var(--bx-fluid-heading-03-font-weight);
|
||||
letter-spacing: var(--bx-fluid-heading-03-letter-spacing);
|
||||
line-height: var(--bx-fluid-heading-03-line-height);
|
||||
}
|
||||
|
||||
.bx--col > p {
|
||||
|
|
@ -238,32 +216,32 @@ html[theme="g90"] .code-override {
|
|||
}
|
||||
|
||||
.bx--col > p > code {
|
||||
font-size: var(--cds-code-02-font-size);
|
||||
font-weight: var(--cds-code-02-font-weight);
|
||||
line-height: var(--cds-code-02-line-height);
|
||||
letter-spacing: var(--cds-code-02-letter-spacing);
|
||||
background-color: var(--cds-ui-03);
|
||||
font-size: var(--bx-code-02-font-size);
|
||||
font-weight: var(--bx-code-02-font-weight);
|
||||
line-height: var(--bx-code-02-line-height);
|
||||
letter-spacing: var(--bx-code-02-letter-spacing);
|
||||
background-color: var(--bx-layer-accent-01);
|
||||
border-radius: 0.25rem;
|
||||
padding: 0 var(--cds-spacing-02);
|
||||
padding: 0 var(--bx-spacing-02);
|
||||
}
|
||||
|
||||
[class*="bx--col"] > h2,
|
||||
.bx--tab-content > h2 {
|
||||
font-size: var(--cds-expressive-heading-04-font-size);
|
||||
font-weight: var(--cds-expressive-heading-04-font-weight);
|
||||
letter-spacing: var(--cds-expressive-heading-04-letter-spacing);
|
||||
line-height: var(--cds-expressive-heading-04-line-height);
|
||||
padding-top: var(--cds-layout-03);
|
||||
margin-bottom: var(--cds-layout-01);
|
||||
font-size: var(--bx-fluid-heading-04-font-size);
|
||||
font-weight: var(--bx-fluid-heading-04-font-weight);
|
||||
letter-spacing: var(--bx-fluid-heading-04-letter-spacing);
|
||||
line-height: var(--bx-fluid-heading-04-line-height);
|
||||
padding-top: var(--bx-spacing-07);
|
||||
margin-bottom: var(--bx-spacing-05);
|
||||
}
|
||||
|
||||
.bx--col > h4 {
|
||||
font-size: var(--cds-expressive-heading-02-font-size);
|
||||
font-weight: var(--cds-expressive-heading-02-font-weight);
|
||||
letter-spacing: var(--cds-expressive-heading-02-letter-spacing);
|
||||
line-height: var(--cds-expressive-heading-02-line-height);
|
||||
padding-top: var(--cds-layout-04);
|
||||
margin-bottom: var(--cds-layout-01);
|
||||
font-size: var(--bx-fluid-heading-02-font-size);
|
||||
font-weight: var(--bx-fluid-heading-02-font-weight);
|
||||
letter-spacing: var(--bx-fluid-heading-02-letter-spacing);
|
||||
line-height: var(--bx-fluid-heading-02-line-height);
|
||||
padding-top: var(--bx-spacing-09);
|
||||
margin-bottom: var(--bx-spacing-05);
|
||||
}
|
||||
|
||||
.bx--col > h2,
|
||||
|
|
@ -274,5 +252,5 @@ html[theme="g90"] .code-override {
|
|||
}
|
||||
|
||||
.bx--col > p {
|
||||
margin-bottom: var(--cds-layout-02);
|
||||
margin-bottom: var(--bx-spacing-06);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
import App from "./App.svelte";
|
||||
import "../../css/all.css";
|
||||
import "carbon-components-svelte/css/all.css";
|
||||
import "./global.css";
|
||||
|
||||
const app = new App({ target: document.body });
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
|
||||
// TODO: `find` is not supported in IE
|
||||
$: api_components = components.map((i) =>
|
||||
COMPONENT_API.components.find((_) => _.moduleName === i),
|
||||
COMPONENT_API.components.find((_) => _.moduleName === i)
|
||||
);
|
||||
$: multiple = api_components.length > 1;
|
||||
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
const searchParams = new URLSearchParams(window.location.search);
|
||||
const current_theme = searchParams.get("theme");
|
||||
|
||||
if (["white", "g10", "g80", "g90", "g100"].includes(current_theme)) {
|
||||
if (["white", "g10", "g90", "g100"].includes(current_theme)) {
|
||||
theme.set(current_theme);
|
||||
}
|
||||
});
|
||||
|
|
@ -62,7 +62,7 @@
|
|||
|
||||
// TODO: [refactor] read from package.json value
|
||||
$: sourceCode = `https://github.com/carbon-design-system/carbon-components-svelte/tree/master/${formatSourceURL(
|
||||
multiple,
|
||||
multiple
|
||||
)}`;
|
||||
</script>
|
||||
|
||||
|
|
@ -83,11 +83,10 @@
|
|||
id="select-theme"
|
||||
inline
|
||||
labelText="Theme"
|
||||
bind:selected={$theme}
|
||||
bind:selected="{$theme}"
|
||||
>
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
|
@ -95,8 +94,8 @@
|
|||
kind="ghost"
|
||||
target="_blank"
|
||||
size="field"
|
||||
href={sourceCode}
|
||||
icon={Code}
|
||||
href="{sourceCode}"
|
||||
icon="{Code}"
|
||||
>
|
||||
Source code
|
||||
</Button>
|
||||
|
|
@ -144,28 +143,28 @@
|
|||
</Row>
|
||||
|
||||
<Row>
|
||||
<Column class="prose" noGutter={multiple}>
|
||||
<Column class="prose" noGutter="{multiple}">
|
||||
{#if multiple}
|
||||
<Tabs class="override-tabs">
|
||||
{#each api_components as component (component.moduleName)}
|
||||
<Tab label={component.moduleName} />
|
||||
<Tab label="{component.moduleName}" />
|
||||
{/each}
|
||||
<div slot="content" style="padding-top: var(--cds-spacing-06)">
|
||||
<div slot="content" style="padding-top: var(--bx-spacing-06)">
|
||||
{#each api_components as component (component.moduleName)}
|
||||
<TabContent>
|
||||
<ComponentApi {component} />
|
||||
<ComponentApi component="{component}" />
|
||||
</TabContent>
|
||||
{/each}
|
||||
</div>
|
||||
</Tabs>
|
||||
{:else}
|
||||
<ComponentApi component={api_components[0]} />
|
||||
<ComponentApi component="{api_components[0]}" />
|
||||
{/if}
|
||||
</Column>
|
||||
</Row>
|
||||
</Grid>
|
||||
|
||||
<Column class="table" xlg={4} lg={5}>
|
||||
<Column class="table" xlg="{4}" lg="{5}">
|
||||
<div class="toc">
|
||||
<h5>Examples</h5>
|
||||
<slot name="aside" />
|
||||
|
|
@ -177,13 +176,13 @@
|
|||
.bar {
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
margin-bottom: var(--cds-layout-02);
|
||||
border-bottom: 1px solid var(--cds-ui-03);
|
||||
margin-bottom: var(--bx-spacing-06);
|
||||
border-bottom: 1px solid var(--bx-ui-03);
|
||||
}
|
||||
|
||||
:global(.toc h5) {
|
||||
margin-top: var(--cds-spacing-06);
|
||||
margin-bottom: var(--cds-spacing-03);
|
||||
margin-top: var(--bx-spacing-06);
|
||||
margin-bottom: var(--bx-spacing-03);
|
||||
}
|
||||
|
||||
.toc.mobile {
|
||||
|
|
@ -193,7 +192,7 @@
|
|||
@media (max-width: 1056px) {
|
||||
.toc.mobile {
|
||||
display: block;
|
||||
margin-bottom: var(--cds-spacing-09);
|
||||
margin-bottom: var(--bx-spacing-09);
|
||||
}
|
||||
}
|
||||
</style>
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@
|
|||
<h1>404</h1>
|
||||
<div>
|
||||
Page not found.
|
||||
<Link href={$url("/")}>Return home</Link>
|
||||
<Link href="{$url('/')}">Return home</Link>
|
||||
</div>
|
||||
</Column>
|
||||
</Row>
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@
|
|||
|
||||
$: isMobile = innerWidth < 1056;
|
||||
$: components = $layout.children.filter(
|
||||
(child) => child.title === "components",
|
||||
(child) => child.title === "components"
|
||||
)[0];
|
||||
|
||||
$beforeUrlChange(() => {
|
||||
|
|
@ -65,7 +65,7 @@
|
|||
<svelte:window bind:innerWidth />
|
||||
|
||||
<svelte:body
|
||||
on:keydown={(e) => {
|
||||
on:keydown="{(e) => {
|
||||
if (active) return;
|
||||
if (
|
||||
document.activeElement instanceof HTMLInputElement ||
|
||||
|
|
@ -74,76 +74,34 @@
|
|||
// Exit early if an inputtable element is already focused.
|
||||
return;
|
||||
}
|
||||
|
||||
const isCommandOrControl = e.metaKey || e.ctrlKey;
|
||||
const isCmdK = isCommandOrControl && e.key.toLowerCase() === "k";
|
||||
const isSlash = e.key === "/";
|
||||
|
||||
if (isCmdK || isSlash) {
|
||||
if ((e.metaKey && e.key === 'k') || e.key === '/') {
|
||||
e.preventDefault();
|
||||
active = true;
|
||||
}
|
||||
}}
|
||||
/>
|
||||
|
||||
<svelte:head>
|
||||
<!-- Tealium/GA Set up -->
|
||||
<script type="text/javascript">
|
||||
window._ibmAnalytics = {
|
||||
settings: {
|
||||
name: "CarbonSvelte",
|
||||
isSpa: true,
|
||||
tealiumProfileName: "ibm-web-app",
|
||||
},
|
||||
onLoad: [["ibmStats.pageview", []]],
|
||||
};
|
||||
digitalData = {
|
||||
page: {
|
||||
pageInfo: {
|
||||
ibm: {
|
||||
siteId: "IBM_" + _ibmAnalytics.settings.name,
|
||||
},
|
||||
},
|
||||
category: {
|
||||
primaryCategory: "PC100",
|
||||
},
|
||||
},
|
||||
};
|
||||
</script>
|
||||
<script
|
||||
type="module"
|
||||
defer
|
||||
src="https://1.www.s81c.com/common/carbon-for-ibm-dotcom/tag/v1/latest/footer.min.js"
|
||||
></script>
|
||||
<script
|
||||
src="//1.www.s81c.com/common/stats/ibm-common.js"
|
||||
type="text/javascript"
|
||||
defer
|
||||
></script>
|
||||
</svelte:head>
|
||||
}}" />
|
||||
|
||||
<Theme
|
||||
persist
|
||||
bind:theme={$theme}
|
||||
on:update={(e) => {
|
||||
bind:theme="{$theme}"
|
||||
on:update="{(e) => {
|
||||
const theme = e.detail.theme;
|
||||
document.documentElement.style.setProperty(
|
||||
"color-scheme",
|
||||
["white", "g10"].includes(theme) ? "light" : "dark",
|
||||
'color-scheme',
|
||||
['white', 'g10'].includes(theme) ? 'light' : 'dark'
|
||||
);
|
||||
}}
|
||||
}}"
|
||||
>
|
||||
<Header
|
||||
aria-label="Navigation"
|
||||
href={$url("/")}
|
||||
expandedByDefault={true}
|
||||
href="{$url('/')}"
|
||||
expandedByDefault="{true}"
|
||||
bind:isSideNavOpen
|
||||
>
|
||||
<svelte:fragment slot="skip-to-content">
|
||||
<SkipToContent />
|
||||
</svelte:fragment>
|
||||
|
||||
<span slot="platform" class="platform-name" class:hidden={active}>
|
||||
<span slot="platform" class="platform-name" class:hidden="{active}">
|
||||
Carbon Components Svelte <code class="code-01"
|
||||
>v{process.env.VERSION || ""}</code
|
||||
>
|
||||
|
|
@ -153,17 +111,17 @@
|
|||
bind:value
|
||||
bind:active
|
||||
placeholder="Search"
|
||||
{results}
|
||||
on:select={(e) => {
|
||||
results="{results}"
|
||||
on:select="{(e) => {
|
||||
$goto(e.detail.selectedResult.href);
|
||||
}}
|
||||
}}"
|
||||
/>
|
||||
<HeaderActionLink
|
||||
icon={LogoGithub}
|
||||
icon="{LogoGithub}"
|
||||
href="https://github.com/carbon-design-system/carbon-components-svelte"
|
||||
target="_blank"
|
||||
/>
|
||||
<HeaderAction transition={false} bind:isOpen>
|
||||
<HeaderAction transition="{false}" bind:isOpen>
|
||||
<HeaderPanelLinks>
|
||||
<HeaderPanelDivider>Carbon Svelte portfolio</HeaderPanelDivider>
|
||||
<HeaderPanelLink
|
||||
|
|
@ -198,13 +156,13 @@
|
|||
</HeaderUtilities>
|
||||
</Header>
|
||||
|
||||
<SideNav bind:isOpen={isSideNavOpen}>
|
||||
<SideNav bind:isOpen="{isSideNavOpen}">
|
||||
<SideNavItems>
|
||||
{#each components.children.filter((child) => !deprecated.includes(child.title)) as child (child.path)}
|
||||
<SideNavMenuItem
|
||||
text={child.title}
|
||||
href={$url(child.path)}
|
||||
isSelected={$isActive($url(child.path))}
|
||||
text="{child.title}"
|
||||
href="{$url(child.path)}"
|
||||
isSelected="{$isActive($url(child.path))}"
|
||||
>
|
||||
{child.title}
|
||||
{#if deprecated.includes(child.title)}
|
||||
|
|
|
|||
|
|
@ -10,15 +10,8 @@ components: ["Accordion", "AccordionItem", "AccordionSkeleton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`Accordion` creates a vertically stacked list of expandable sections that show or hide content. It supports custom titles, different sizes, and various states including disabled and skeleton loading.
|
||||
|
||||
## Default
|
||||
|
||||
Use the `Accordion` and `AccordionItem` components to compose a collapsible list of
|
||||
items.
|
||||
|
||||
By default, the chevron icon is on the right side of the accordion item.
|
||||
|
||||
<Accordion>
|
||||
<AccordionItem title="Natural Language Classifier">
|
||||
<p>Natural Language Classifier uses advanced natural language processing and machine learning techniques to create custom classification models. Users train their data and the service predicts the appropriate category for the inputted text.
|
||||
|
|
@ -34,10 +27,6 @@ By default, the chevron icon is on the right side of the accordion item.
|
|||
|
||||
## Left-aligned chevron
|
||||
|
||||
The chevron icon can be aligned to the left side of the accordion item by setting
|
||||
the `align` prop to "start". This provides an alternative visual style while
|
||||
maintaining the same functionality.
|
||||
|
||||
<Accordion align="start">
|
||||
<AccordionItem title="Natural Language Classifier">
|
||||
<p>Natural Language Classifier uses advanced natural language processing and machine learning techniques to create custom classification models. Users train their data and the service predicts the appropriate category for the inputted text.
|
||||
|
|
@ -53,9 +42,6 @@ maintaining the same functionality.
|
|||
|
||||
## Custom title slot
|
||||
|
||||
Customize the title content by using the `title` slot instead of the `title` prop.
|
||||
This allows for more complex title layouts with multiple elements.
|
||||
|
||||
<Accordion>
|
||||
<AccordionItem>
|
||||
<svelte:fragment slot="title">
|
||||
|
|
@ -83,9 +69,6 @@ This allows for more complex title layouts with multiple elements.
|
|||
|
||||
## First item open
|
||||
|
||||
Set the `open` prop on an `AccordionItem` to have it expanded by default when the
|
||||
accordion is first rendered.
|
||||
|
||||
<Accordion>
|
||||
<AccordionItem open title="Natural Language Classifier">
|
||||
<p>Natural Language Classifier uses advanced natural language processing and machine learning techniques to create custom classification models. Users train their data and the service predicts the appropriate category for the inputted text.
|
||||
|
|
@ -101,19 +84,13 @@ accordion is first rendered.
|
|||
|
||||
## Programmatic example
|
||||
|
||||
This example demonstrates how to programmatically control the accordion items using
|
||||
the `bind:open` directive. Expand and collapse items based on user
|
||||
interactions or application state.
|
||||
This example demonstrates how a list of items can be programmatically expanded and collapsed.
|
||||
|
||||
<FileSource src="/framed/Accordion/ExpandableAccordion" />
|
||||
|
||||
## Extra-large size
|
||||
## Large size
|
||||
|
||||
The accordion can be displayed in an extra-large size by setting the `size` prop to
|
||||
"xl". This provides more visual emphasis and is suitable for prominent content
|
||||
sections.
|
||||
|
||||
<Accordion size="xl">
|
||||
<Accordion size="lg">
|
||||
<AccordionItem title="Natural Language Classifier">
|
||||
<p>Natural Language Classifier uses advanced natural language processing and machine learning techniques to create custom classification models. Users train their data and the service predicts the appropriate category for the inputted text.
|
||||
</p>
|
||||
|
|
@ -128,10 +105,6 @@ sections.
|
|||
|
||||
## Small size
|
||||
|
||||
For more compact layouts, set the `size` prop to "sm" to display the accordion in a
|
||||
smaller size. This is useful when space is limited or when the accordion is used as
|
||||
a secondary UI element.
|
||||
|
||||
<Accordion size="sm">
|
||||
<AccordionItem title="Natural Language Classifier">
|
||||
<p>Natural Language Classifier uses advanced natural language processing and machine learning techniques to create custom classification models. Users train their data and the service predicts the appropriate category for the inputted text.
|
||||
|
|
@ -147,9 +120,6 @@ a secondary UI element.
|
|||
|
||||
## Disabled
|
||||
|
||||
Set the `disabled` prop on the `Accordion` component to disable all items at once.
|
||||
This prevents users from expanding or collapsing any items in the accordion.
|
||||
|
||||
<Accordion disabled>
|
||||
<AccordionItem title="Natural Language Classifier">
|
||||
<p>Natural Language Classifier uses advanced natural language processing and machine learning techniques to create custom classification models. Users train their data and the service predicts the appropriate category for the inputted text.
|
||||
|
|
@ -165,10 +135,6 @@ This prevents users from expanding or collapsing any items in the accordion.
|
|||
|
||||
## Disabled (item)
|
||||
|
||||
Individual accordion items can be disabled by setting the `disabled` prop on
|
||||
specific `AccordionItem` components. This allows for more granular control over
|
||||
which items are interactive.
|
||||
|
||||
<Accordion>
|
||||
<AccordionItem disabled title="Natural Language Classifier">
|
||||
<p>Natural Language Classifier uses advanced natural language processing and machine learning techniques to create custom classification models. Users train their data and the service predicts the appropriate category for the inputted text.
|
||||
|
|
@ -184,45 +150,25 @@ which items are interactive.
|
|||
|
||||
## Skeleton
|
||||
|
||||
The skeleton state provides a loading placeholder for the accordion. It displays a
|
||||
simplified version of the component while content is being loaded.
|
||||
|
||||
<Accordion skeleton />
|
||||
|
||||
## Skeleton (left-aligned chevron)
|
||||
|
||||
The skeleton state can be combined with the left-aligned chevron style by setting
|
||||
both the `skeleton` and `align="start"` props.
|
||||
|
||||
<Accordion skeleton align="start" />
|
||||
|
||||
## Skeleton (custom count)
|
||||
|
||||
By default, the skeleton state displays 4 items.
|
||||
|
||||
Specify the number of skeleton items to display using the `count` prop. This is
|
||||
useful when you know the exact number of items that will be loaded.
|
||||
|
||||
<Accordion skeleton count={3} />
|
||||
|
||||
## Skeleton (closed)
|
||||
|
||||
By default, the first skeleton item is open. The skeleton state can be displayed
|
||||
in a collapsed state by setting `open={false}`.
|
||||
|
||||
<Accordion skeleton open={false} />
|
||||
|
||||
## Skeleton (extra-large)
|
||||
|
||||
The skeleton state supports the extra-large size variant, maintaining visual
|
||||
consistency with the active component states.
|
||||
|
||||
<Accordion skeleton size="xl" />
|
||||
|
||||
## Skeleton (small)
|
||||
|
||||
The skeleton state also supports the small size variant, providing a compact
|
||||
loading placeholder for space-constrained layouts.
|
||||
|
||||
<Accordion skeleton size="sm" />
|
||||
|
||||
|
|
|
|||
|
|
@ -3,13 +3,11 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `AspectRatio` component maintains consistent proportions for content across different screen sizes. It's particularly useful for images, videos, and other media that need to preserve their aspect ratio when resizing.
|
||||
The `AspectRatio` component is useful for constraining fluid content within an aspect ratio. To demo this, resize your browser for the examples below.
|
||||
|
||||
Supported aspect ratios include `"2x1"`, `"2x3"`, `"16x9"`, `"4x3"`, `"1x1"`, `"3x4"`, `"3x2"`, `"9x16"` and `"1x2"`.
|
||||
|
||||
## Default
|
||||
|
||||
Display a 2:1 aspect ratio container by default.
|
||||
## Default (2x1)
|
||||
|
||||
<AspectRatio>
|
||||
2x1
|
||||
|
|
|
|||
|
|
@ -12,12 +12,8 @@ components: ["Breadcrumb", "BreadcrumbItem"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`Breadcrumb` displays a hierarchical navigation trail that shows users their current location within an application. It supports current page indication, trailing slash customization, and overflow handling for long navigation paths.
|
||||
|
||||
## Default
|
||||
|
||||
Display a hierarchical navigation trail with slashes between items. Mark the current page with `isCurrentPage`.
|
||||
|
||||
<Breadcrumb>
|
||||
<BreadcrumbItem href="/">Dashboard</BreadcrumbItem>
|
||||
<BreadcrumbItem href="/reports">Annual reports</BreadcrumbItem>
|
||||
|
|
@ -26,8 +22,6 @@ Display a hierarchical navigation trail with slashes between items. Mark the cur
|
|||
|
||||
## No trailing slash
|
||||
|
||||
Remove the trailing slash from the last breadcrumb item using `noTrailingSlash`.
|
||||
|
||||
<Breadcrumb noTrailingSlash>
|
||||
<BreadcrumbItem href="/">Home</BreadcrumbItem>
|
||||
<BreadcrumbItem href="/profile" isCurrentPage>Profile</BreadcrumbItem>
|
||||
|
|
@ -35,8 +29,6 @@ Remove the trailing slash from the last breadcrumb item using `noTrailingSlash`.
|
|||
|
||||
## Overflow menu
|
||||
|
||||
Add an `OverflowMenu` to handle long breadcrumb trails. Use `OverflowMenuItem` components for menu options.
|
||||
|
||||
<Breadcrumb>
|
||||
<BreadcrumbItem href="/">Home</BreadcrumbItem>
|
||||
<BreadcrumbItem href="/api">API documentation</BreadcrumbItem>
|
||||
|
|
@ -55,6 +47,4 @@ Add an `OverflowMenu` to handle long breadcrumb trails. Use `OverflowMenuItem` c
|
|||
|
||||
## Skeleton
|
||||
|
||||
Display a loading state with `skeleton` prop. Use `count` to specify the number of items.
|
||||
|
||||
<Breadcrumb noTrailingSlash skeleton count={3} />
|
||||
|
|
@ -1,14 +1,14 @@
|
|||
|
||||
<script>
|
||||
import {
|
||||
UnorderedList, ListItem
|
||||
Breakpoint, UnorderedList, ListItem
|
||||
} from "carbon-components-svelte";
|
||||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The Carbon Design System [grid implementation](https://carbondesignsystem.com/guidelines/2x-grid/implementation#responsive-options) defines five responsive breakpoints:
|
||||
The [Carbon Design System grid implementation](https://carbondesignsystem.com/guidelines/2x-grid/implementation#responsive-options) defines five responsive breakpoints:
|
||||
|
||||
<UnorderedList svx-ignore style="margin-bottom: var(--cds-spacing-08)">
|
||||
<UnorderedList svx-ignore style="margin-bottom: var(--bx-spacing-08)">
|
||||
<ListItem><strong>Small</strong>: less than 672px</ListItem>
|
||||
<ListItem><strong>Medium</strong>: 672 - 1056px</ListItem>
|
||||
<ListItem><strong>Large</strong>: 1056 - 1312px</ListItem>
|
||||
|
|
@ -28,8 +28,8 @@ The `"on:change"` event will fire when the size is initially determined and when
|
|||
|
||||
## Store and Breakpoint Values
|
||||
|
||||
Use `breakpointObserver` as an alternative to the component to get the current size as a Svelte store. The store provides two additional functions that create derived stores returning a `boolean` indicating whether the size is smaller/larger than a certain breakpoint.
|
||||
As an alternative to the component, `breakpointObserver` can be used to get the current size as a Svelte store. The store has two additional functions which create derived stores that return a `boolean` indicating whether the size is smaller/larger than a certain breakpoint.
|
||||
|
||||
Access the `breakpoints` dictionary to map from `BreakpointSize` to `BreakpointValue`.
|
||||
There also exists a `breakpoints` dictionary mapping from `BreakpointSize` to `BreakpointValue`.
|
||||
|
||||
<FileSource src="/framed/Breakpoint/BreakpointObserver" />
|
||||
|
|
|
|||
|
|
@ -4,73 +4,57 @@
|
|||
import TrashCan from "carbon-icons-svelte/lib/TrashCan.svelte";
|
||||
import Login from "carbon-icons-svelte/lib/Login.svelte";
|
||||
import Preview from "../../components/Preview.svelte";
|
||||
|
||||
let index = 1;
|
||||
</script>
|
||||
|
||||
Buttons trigger actions in the interface. Use them to submit forms, navigate between pages, or perform specific tasks. Choose from different styles and sizes to match the importance and context of each action.
|
||||
|
||||
## Primary button
|
||||
|
||||
The default button style is primary. This should be used for primary actions.
|
||||
|
||||
<Button>Primary button</Button>
|
||||
|
||||
## Secondary button
|
||||
|
||||
Set `kind="secondary"` for secondary actions.
|
||||
|
||||
<Button kind="secondary">Secondary button</Button>
|
||||
|
||||
## Tertiary button
|
||||
|
||||
Set `kind="tertiary"` for tertiary actions.
|
||||
|
||||
<Button kind="tertiary">Tertiary button</Button>
|
||||
|
||||
## Ghost button
|
||||
|
||||
Set `kind="ghost"` for ghost-style buttons.
|
||||
|
||||
<Button kind="ghost">Ghost button</Button>
|
||||
|
||||
## Danger button
|
||||
|
||||
Set `kind="danger"` for destructive actions.
|
||||
|
||||
<Button kind="danger">Danger button</Button>
|
||||
|
||||
## Danger tertiary button
|
||||
|
||||
Set `kind="danger-tertiary"` for less prominent destructive actions.
|
||||
|
||||
<Button kind="danger-tertiary">Danger tertiary button</Button>
|
||||
<Button kind="danger--tertiary">Danger tertiary button</Button>
|
||||
|
||||
## Danger tertiary, icon-only button
|
||||
|
||||
<InlineNotification svx-ignore lowContrast title="Note:" kind="info" hideCloseButton>
|
||||
<div class="body-short-01">
|
||||
Provide an <strong>iconDescription</strong> for accessibility. This text will be used as the button's tooltip and screen reader label.
|
||||
You must provide an <strong>iconDescription</strong> for the button tooltip.
|
||||
</div>
|
||||
</InlineNotification>
|
||||
|
||||
<Button kind="danger-tertiary" iconDescription="Delete" icon={TrashCan} />
|
||||
<Button kind="danger--tertiary"iconDescription="Delete" icon={TrashCan} />
|
||||
|
||||
## Danger ghost button
|
||||
|
||||
Set `kind="danger-ghost"` for ghost-style destructive actions.
|
||||
|
||||
<Button kind="danger-ghost">Danger ghost button</Button>
|
||||
<Button kind="danger--ghost">Danger ghost button</Button>
|
||||
|
||||
## Button with icon
|
||||
|
||||
Add an icon to the button using the `icon` prop.
|
||||
|
||||
<Button icon={Add}>With icon</Button>
|
||||
|
||||
## Icon-only button
|
||||
|
||||
<InlineNotification svx-ignore lowContrast title="Note:" kind="info" hideCloseButton>
|
||||
<div class="body-short-01">
|
||||
Provide an <strong>iconDescription</strong> for accessibility. This text will be used as the button's tooltip and screen reader label.
|
||||
You must provide an <strong>iconDescription</strong> for the button tooltip.
|
||||
</div>
|
||||
</InlineNotification>
|
||||
|
||||
|
|
@ -78,13 +62,11 @@ Add an icon to the button using the `icon` prop.
|
|||
|
||||
## Icon-only, link button
|
||||
|
||||
Set `href` to create an icon-only link button.
|
||||
|
||||
<Button iconDescription="Login" icon={Login} href="#" />
|
||||
|
||||
## Icon-only button (custom tooltip position)
|
||||
|
||||
Control the tooltip position and alignment with `tooltipPosition` and `tooltipAlignment`.
|
||||
The tooltip position and alignment can be controlled by `tooltipPosition` and `tooltipAlignment`.
|
||||
|
||||
<Button tooltipPosition="right" tooltipAlignment="end" iconDescription="Tooltip text" icon={Add} />
|
||||
|
||||
|
|
@ -96,71 +78,49 @@ Set `isSelected` to `true` to enable the selected state for an icon-only, ghost
|
|||
|
||||
## Link button
|
||||
|
||||
Set `href` to render an [anchor element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) instead of a `button` element.
|
||||
If an `href` value is specified, the component will render an [anchor element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) instead of a `button` element.
|
||||
|
||||
<Button href="#">Link button</Button>
|
||||
|
||||
## Link button with icon
|
||||
|
||||
Similarly, link buttons can have icons.
|
||||
|
||||
<Button href="#" icon={Add}>Link button with icon</Button>
|
||||
|
||||
## Custom element
|
||||
|
||||
By default, the `Button` will render either a `button` or `a` element.
|
||||
|
||||
To render a different element, set `as` to `true` and spread `let:props` to the element.
|
||||
|
||||
<Button as let:props>
|
||||
<p {...props}>Custom element</p>
|
||||
</Button>
|
||||
|
||||
## Field size
|
||||
|
||||
The default size is "default".
|
||||
|
||||
Set `size="field"` for field-sized buttons.
|
||||
|
||||
<Button size="field">Primary</Button>
|
||||
<Button size="field" kind="secondary">Secondary</Button>
|
||||
<Button size="field" kind="tertiary">Tertiary</Button>
|
||||
<Button size="field" kind="ghost">Ghost</Button>
|
||||
<Button size="field" kind="danger">Danger</Button>
|
||||
<Button size="md">Primary</Button>
|
||||
<Button size="md" kind="secondary">Secondary</Button>
|
||||
<Button size="md" kind="tertiary">Tertiary</Button>
|
||||
<Button size="md" kind="ghost">Ghost</Button>
|
||||
<Button size="md" kind="danger">Danger</Button>
|
||||
|
||||
## Small size
|
||||
|
||||
Set `size="small"` for small buttons.
|
||||
|
||||
<Button size="small">Primary</Button>
|
||||
<Button size="small" kind="secondary">Secondary</Button>
|
||||
<Button size="small" kind="tertiary">Tertiary</Button>
|
||||
<Button size="small" kind="ghost">Ghost</Button>
|
||||
<Button size="small" kind="danger">Danger</Button>
|
||||
<Button size="sm">Primary</Button>
|
||||
<Button size="sm" kind="secondary">Secondary</Button>
|
||||
<Button size="sm" kind="tertiary">Tertiary</Button>
|
||||
<Button size="sm" kind="ghost">Ghost</Button>
|
||||
<Button size="sm" kind="danger">Danger</Button>
|
||||
|
||||
## Large size
|
||||
|
||||
Set `size="lg"` for large buttons.
|
||||
|
||||
<Button size="lg">Primary</Button>
|
||||
<Button size="lg" kind="secondary">Secondary</Button>
|
||||
<Button size="lg" kind="tertiary">Tertiary</Button>
|
||||
<Button size="lg" kind="ghost">Ghost</Button>
|
||||
<Button size="lg" kind="danger">Danger</Button>
|
||||
|
||||
## Extra-large size
|
||||
|
||||
Set `size="xl"` for extra-large buttons.
|
||||
|
||||
<Button size="xl">Primary</Button>
|
||||
<Button size="xl" kind="secondary">Secondary</Button>
|
||||
<Button size="xl" kind="tertiary">Tertiary</Button>
|
||||
<Button size="xl" kind="ghost">Ghost</Button>
|
||||
<Button size="xl" kind="danger">Danger</Button>
|
||||
|
||||
## Disabled state
|
||||
## Extra-large size
|
||||
|
||||
Set `disabled` to disable the button.
|
||||
<Button size="2xl">Primary</Button>
|
||||
<Button size="2xl" kind="secondary">Secondary</Button>
|
||||
<Button size="2xl" kind="tertiary">Tertiary</Button>
|
||||
<Button size="2xl" kind="ghost">Ghost</Button>
|
||||
<Button size="2xl" kind="danger">Danger</Button>
|
||||
|
||||
## Disabled state
|
||||
|
||||
<Button disabled>Disabled button</Button>
|
||||
<Button disabled iconDescription="Tooltip text" icon={Add} />
|
||||
|
|
@ -171,7 +131,7 @@ Set `expressive` to `true` to use Carbon's expressive typesetting.
|
|||
|
||||
<InlineNotification svx-ignore lowContrast title="Note:" kind="info" hideCloseButton>
|
||||
<div class="body-short-01">
|
||||
Use expressive styles with default, "lg", or "xl" button sizes.
|
||||
Expressive styles only work with the default, "lg", and "xl" button sizes.
|
||||
</div>
|
||||
</InlineNotification>
|
||||
|
||||
|
|
@ -195,8 +155,6 @@ Set `expressive` to `true` to use Carbon's expressive typesetting.
|
|||
|
||||
## Skeleton
|
||||
|
||||
Set `skeleton` to show a loading state.
|
||||
|
||||
<Button size="xl" skeleton />
|
||||
<Button size="lg" skeleton />
|
||||
<Button skeleton />
|
||||
|
|
@ -205,6 +163,8 @@ Set `skeleton` to show a loading state.
|
|||
|
||||
## Programmatic focus
|
||||
|
||||
Bind to the `ref` prop to access the button element for programmatic focus.
|
||||
Bind to the `ref` prop to access a reference to the underlying button element.
|
||||
|
||||
You can use this reference to programmatically focus the button.
|
||||
|
||||
<FileSource src="/framed/Button/ProgrammaticFocus" />
|
||||
|
|
|
|||
|
|
@ -4,11 +4,9 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
Group related buttons together in a set. Use this component to create consistent spacing and alignment between multiple buttons.
|
||||
|
||||
## Default
|
||||
|
||||
Place buttons side by side in a horizontal layout.
|
||||
Buttons in a button set are juxtaposed by default.
|
||||
|
||||
<ButtonSet>
|
||||
<Button kind="secondary">Cancel</Button>
|
||||
|
|
@ -17,7 +15,7 @@ Place buttons side by side in a horizontal layout.
|
|||
|
||||
## Stacked
|
||||
|
||||
Set `stacked` to `true` to arrange buttons vertically.
|
||||
Set `stacked` to `true` to use the stacked variant.
|
||||
|
||||
<ButtonSet stacked>
|
||||
<Button icon={Login}>Log in</Button>
|
||||
|
|
|
|||
|
|
@ -3,53 +3,39 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
Checkboxes let users select one or more options from a list. Use them for multiple-choice questions, settings, or to confirm actions.
|
||||
|
||||
## Default
|
||||
|
||||
Create a checkbox with a label using `labelText`.
|
||||
|
||||
By default, the checkbox is unchecked.
|
||||
## Default (unchecked)
|
||||
|
||||
<Checkbox labelText="Label text" />
|
||||
|
||||
## Checked
|
||||
|
||||
Set `checked` to `true` to pre-select the checkbox.
|
||||
|
||||
<Checkbox labelText="Label text" checked />
|
||||
|
||||
## Indeterminate
|
||||
|
||||
Set `indeterminate` to `true` to show a mixed state, typically used in parent checkboxes with some children selected.
|
||||
|
||||
<Checkbox labelText="Label text" indeterminate />
|
||||
|
||||
## Hidden label
|
||||
|
||||
Set `hideLabel` to `true` to visually hide the label while keeping it accessible to screen readers.
|
||||
|
||||
<Checkbox labelText="Label text" hideLabel />
|
||||
|
||||
## Disabled state
|
||||
|
||||
Set `disabled` to `true` to prevent user interaction.
|
||||
## Disabled
|
||||
|
||||
<Checkbox labelText="Label text" disabled />
|
||||
|
||||
## Reactive example (bind:checked)
|
||||
|
||||
Use two-way binding with `bind:checked` to track the checkbox state.
|
||||
The `checked` prop supports two-way binding.
|
||||
|
||||
<FileSource src="/framed/Checkbox/CheckboxReactive" />
|
||||
|
||||
## Reactive example (bind:group)
|
||||
|
||||
Bind an array of values using `group` to manage multiple checkboxes. This API is inspired by Svelte [group inputs](https://svelte.dev/tutorial/group-inputs).
|
||||
An alternative to `checked` is binding an array of values using `group`. This API in inspired by Svelte [group inputs](https://svelte.dev/tutorial/group-inputs).
|
||||
|
||||
<InlineNotification svx-ignore lowContrast title="Note:" kind="info" hideCloseButton>
|
||||
<div class="body-short-01">
|
||||
When using <strong>bind:group</strong>, <strong>bind:checked</strong> only supports one-way binding.
|
||||
If using <strong>bind:group</strong>, <strong>bind:checked</strong> will only support one-way binding.
|
||||
</div>
|
||||
</InlineNotification>
|
||||
|
||||
|
|
@ -57,6 +43,4 @@ Bind an array of values using `group` to manage multiple checkboxes. This API is
|
|||
|
||||
## Skeleton
|
||||
|
||||
Set `skeleton` to `true` to show a loading state.
|
||||
|
||||
<Checkbox skeleton />
|
||||
|
|
|
|||
|
|
@ -3,19 +3,15 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
Clickable tiles create interactive content areas that link to other pages or trigger actions. Use them to group related content and provide clear navigation targets.
|
||||
|
||||
## Default
|
||||
|
||||
Create a clickable tile with an `href` to link to another page.
|
||||
|
||||
<ClickableTile href="https://www.carbondesignsystem.com/">
|
||||
Carbon Design System
|
||||
</ClickableTile>
|
||||
|
||||
## Prevent default behavior
|
||||
|
||||
Handle the `click` event to override the default link behavior. Use `e.preventDefault()` to stop navigation.
|
||||
Use the forwarded `click` event and invoke `e.preventDefault()` to prevent the native link behavior.
|
||||
|
||||
<ClickableTile
|
||||
href="/"
|
||||
|
|
@ -29,16 +25,12 @@ Handle the `click` event to override the default link behavior. Use `e.preventDe
|
|||
|
||||
## Light variant
|
||||
|
||||
Set `light` to `true` to use the light color scheme.
|
||||
|
||||
<ClickableTile light href="https://www.carbondesignsystem.com/">
|
||||
Carbon Design System
|
||||
</ClickableTile>
|
||||
|
||||
## Disabled state
|
||||
|
||||
Set `disabled` to `true` to prevent interaction.
|
||||
|
||||
<ClickableTile disabled href="https://www.carbondesignsystem.com/">
|
||||
Carbon Design System
|
||||
</ClickableTile>
|
||||
|
|
|
|||
|
|
@ -27,21 +27,20 @@ let comment = `
|
|||
`
|
||||
</script>
|
||||
|
||||
Code snippets display and copy code examples. They support single-line, multi-line, and inline formats with customizable copy and expand functionality.
|
||||
|
||||
This component uses the native, asynchronous [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard/writeText) to copy text.
|
||||
|
||||
Please note that the `clipboard.writeText` API is not supported in [IE 11 nor Safari iOS version 13.3 or lower](https://caniuse.com/mdn-api_clipboard_writetext).
|
||||
|
||||
You can override the default copy functionality with your own implementation. See [Overriding copy functionality](#overriding-copy-functionality).
|
||||
|
||||
## Default
|
||||
|
||||
Display a single-line code snippet by default.
|
||||
## Default (single-line)
|
||||
|
||||
<CodeSnippet code="npm i carbon-components-svelte" />
|
||||
<CodeSnippet code="yarn add -D carbon-components-svelte" />
|
||||
|
||||
## Overriding copy functionality
|
||||
|
||||
Pass a custom function to the `copy` prop to override the default copy behavior.
|
||||
To override the default copy behavior, pass a custom function to the `copy` prop.
|
||||
|
||||
In this example, we use the open source module [clipboard-copy](https://github.com/feross/clipboard-copy) to copy the text instead of the default Clipboard API.
|
||||
|
||||
|
|
@ -49,37 +48,33 @@ In this example, we use the open source module [clipboard-copy](https://github.c
|
|||
|
||||
## Preventing copy functionality
|
||||
|
||||
Pass a no-op function to the `copy` prop to disable copying.
|
||||
To prevent text from being copied entirely, pass a no-op function to the `copy` prop.
|
||||
|
||||
<CodeSnippet code="npm i carbon-components-svelte" copy={() => {}} />
|
||||
<CodeSnippet code="yarn add -D carbon-components-svelte" copy={() => {}} />
|
||||
|
||||
## Inline
|
||||
|
||||
Set `type="inline"` to display code inline with text.
|
||||
|
||||
<CodeSnippet type="inline" code="rm -rf node_modules/" />
|
||||
|
||||
## Multi-line
|
||||
|
||||
Set `type="multi"` to display multiple lines of code with expand/collapse functionality.
|
||||
|
||||
<CodeSnippet type="multi" {code} />
|
||||
|
||||
## Expanded by default
|
||||
|
||||
Set `expanded` to `true` to show the full multi-line code snippet.
|
||||
Use the `expanded` prop to control whether the multi-line code snippet is expanded or not.
|
||||
|
||||
<CodeSnippet type="multi" {code} expanded />
|
||||
|
||||
## Reactive example
|
||||
|
||||
The multi-line code snippet dispatches "expand" and "collapse" events.
|
||||
The multi-line code snippet also dispatches "expand" and "collapse" events.
|
||||
|
||||
<FileSource src="/framed/CodeSnippet/CodeSnippetReactive" />
|
||||
|
||||
## Custom copy feedback text
|
||||
|
||||
Set `feedback` to customize the copy button feedback text.
|
||||
Use the `feedback` prop to override the default copy button feedback text.
|
||||
|
||||
<CodeSnippet type="multi" {code} feedback="Copied to clipboard" />
|
||||
|
||||
|
|
@ -89,62 +84,40 @@ Set `hideCopyButton` to `true` to hide the copy button.
|
|||
|
||||
<CodeSnippet type="multi" {code} hideCopyButton />
|
||||
|
||||
## Hidden show more button
|
||||
|
||||
Set `showMoreLess` to `false` to hide the expand/collapse button on multi-line snippets.
|
||||
|
||||
<CodeSnippet type="multi" {code} showMoreLess={false} />
|
||||
|
||||
## Hidden copy, show more buttons
|
||||
|
||||
Hide both the copy and expand/collapse buttons.
|
||||
|
||||
<CodeSnippet type="multi" {code} hideCopyButton showMoreLess={false} />
|
||||
|
||||
## Custom show more/less text
|
||||
|
||||
Set `showMoreText` and `showLessText` to customize the expand/collapse button text.
|
||||
|
||||
<CodeSnippet type="multi" {code} showMoreText="Expand" showLessText="Collapse" />
|
||||
|
||||
## Disabled
|
||||
|
||||
Set `disabled` to `true` to disable interaction. This only applies to `"single"` and `"multi"` types.
|
||||
The `disabled` prop applies only to the `"single"` and `"multi"` code snippet types.
|
||||
|
||||
<CodeSnippet disabled code="npm i carbon-components-svelte" />
|
||||
<CodeSnippet disabled code="yarn add -D carbon-components-svelte" />
|
||||
<br />
|
||||
<CodeSnippet disabled type="multi" code="{comment}" />
|
||||
|
||||
## Wrapped text
|
||||
|
||||
By default, the code snippet preserves text formatting and does not wrap text.
|
||||
|
||||
Set `wrapText` to `true` to wrap long lines in multi-line snippets.
|
||||
`wrapText` only applies to the `"multi"` type.
|
||||
|
||||
<CodeSnippet wrapText type="multi" code="{comment}" />
|
||||
|
||||
## Dynamic multi-line code
|
||||
|
||||
Use the `code` prop instead of the default slot for dynamically updated code.
|
||||
For dynamically updated code, you must use the `code` prop instead of the default slot.
|
||||
|
||||
<FileSource src="/framed/CodeSnippet/DynamicCodeSnippet" />
|
||||
|
||||
## Hidden multi-line code
|
||||
|
||||
The "Show more" button relies on the element's computed height. For hidden content, the button won't appear because the height is `0`.
|
||||
There may be cases where your code snippet is hidden in the DOM. The logic to render the "Show more" button relies on the element's computed height. For hidden content, the button will not appear because the computed height is `0`.
|
||||
|
||||
Re-render the component to fix this issue.
|
||||
The recommended workaround is to re-render the component. See the example below.
|
||||
|
||||
<FileSource src="/framed/CodeSnippet/HiddenCodeSnippet" />
|
||||
|
||||
## Skeleton
|
||||
|
||||
Set `skeleton` to `true` to show a loading state. Defaults to `"single"` type.
|
||||
The default skeleton type is `"single"`.
|
||||
|
||||
<CodeSnippet skeleton />
|
||||
|
||||
## Skeleton (multi-line)
|
||||
|
||||
Set `type="multi"` with `skeleton` to show a multi-line loading state.
|
||||
|
||||
<CodeSnippet type="multi" skeleton />
|
||||
|
|
@ -3,8 +3,6 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`ComboBox` combines a text input with a dropdown menu to let users select from predefined options or enter custom values. It supports filtering, custom item rendering, and various states.
|
||||
|
||||
`ComboBox` is keyed for performance reasons.
|
||||
|
||||
<InlineNotification svx-ignore lowContrast title="Note:" kind="info" hideCloseButton>
|
||||
|
|
@ -13,8 +11,6 @@
|
|||
|
||||
## Default
|
||||
|
||||
Create a combobox with a title and placeholder text. Each item requires a unique `id` and `text`.
|
||||
|
||||
<ComboBox titleText="Contact" placeholder="Select contact method"
|
||||
items={[
|
||||
{id: "0", text: "Slack"},
|
||||
|
|
@ -24,25 +20,12 @@ items={[
|
|||
|
||||
## Custom slot
|
||||
|
||||
Override the default slot to customize how each item displays. Access the item and index through the `let:` directive.
|
||||
Override the default slot to customize the display of each item. Access the item and index through the `let:` directive.
|
||||
|
||||
<FileSource src="/framed/ComboBox/ComboBoxSlot" />
|
||||
|
||||
## Hidden label
|
||||
|
||||
Set `hideLabel` to `true` to visually hide the label while keeping it accessible to screen readers.
|
||||
|
||||
<ComboBox hideLabel titleText="Hidden Label" placeholder="Select contact method"
|
||||
items={[
|
||||
{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}
|
||||
]} />
|
||||
|
||||
## Initial selected id
|
||||
|
||||
Set `selectedId` to pre-select an item when the combobox loads.
|
||||
|
||||
<ComboBox titleText="Contact" placeholder="Select contact method"
|
||||
selectedId="1"
|
||||
items={[
|
||||
|
|
@ -53,39 +36,33 @@ items={[
|
|||
|
||||
## Reactive example
|
||||
|
||||
See how the combobox responds to user input and selection changes.
|
||||
|
||||
<FileSource src="/framed/ComboBox/ReactiveComboBox" />
|
||||
|
||||
## Clear selection
|
||||
|
||||
Use `bind:this` to access the component instance and call `ComboBox.clear()` to programmatically clear the selection.
|
||||
To programmatically clear the selection, access the component instance using the [bind:this](https://svelte.dev/docs#bind_element) directive and invoke the `ComboBox.clear()` accessor.
|
||||
|
||||
Set `focus: false` in the method options to prevent re-focusing the input.
|
||||
Specify `focus: false` in the method options to avoid re-focusing the input.
|
||||
|
||||
<FileSource src="/framed/ComboBox/ComboBoxClear" />
|
||||
|
||||
## Multiple combo boxes
|
||||
|
||||
See how to manage multiple comboboxes in a form.
|
||||
|
||||
<FileSource src="/framed/ComboBox/MultipleComboBox" />
|
||||
|
||||
## Filterable
|
||||
|
||||
Enable filtering to let users search through the options.
|
||||
|
||||
<FileSource src="/framed/ComboBox/FilterableComboBox" />
|
||||
|
||||
## Filterable with custom label
|
||||
|
||||
Set `itemToString` to customize how items display in the filterable combobox.
|
||||
Combine a custom label `itemToString` with the filterable option (e.g., internationalization).
|
||||
|
||||
<FileSource src="/framed/ComboBox/FilterableComboBoxCustomLabel" />
|
||||
|
||||
## Top direction
|
||||
|
||||
Set `direction` to `"top"` to make the dropdown menu appear above the input.
|
||||
Set `direction` to `"top"` for the combobox dropdown menu to appear above the input.
|
||||
|
||||
<ComboBox direction="top" titleText="Contact" placeholder="Select contact method"
|
||||
items={[
|
||||
|
|
@ -96,8 +73,6 @@ items={[
|
|||
|
||||
## Light variant
|
||||
|
||||
Set `light` to `true` to use the light color scheme.
|
||||
|
||||
<ComboBox light titleText="Contact" placeholder="Select contact method"
|
||||
items={[
|
||||
{id: "0", text: "Slack"},
|
||||
|
|
@ -105,12 +80,10 @@ items={[
|
|||
{id: "2", text: "Fax"}
|
||||
]} />
|
||||
|
||||
## Extra-large size
|
||||
|
||||
Set `size` to `"xl"` for an extra-large combobox.
|
||||
## Large size
|
||||
|
||||
<ComboBox titleText="Contact" placeholder="Select contact method"
|
||||
size="xl"
|
||||
size="lg"
|
||||
items={[
|
||||
{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
|
|
@ -119,8 +92,6 @@ items={[
|
|||
|
||||
## Small size
|
||||
|
||||
Set `size` to `"sm"` for a small combobox.
|
||||
|
||||
<ComboBox titleText="Contact" placeholder="Select contact method"
|
||||
size="sm"
|
||||
items={[
|
||||
|
|
@ -131,8 +102,6 @@ items={[
|
|||
|
||||
## Invalid state
|
||||
|
||||
Set `invalid` to `true` and provide `invalidText` to show an error message.
|
||||
|
||||
<ComboBox invalid invalidText="Secondary contact method must be different from the primary contact" titleText="Contact" placeholder="Select contact method"
|
||||
items={[
|
||||
{id: "0", text: "Slack"},
|
||||
|
|
@ -142,8 +111,6 @@ items={[
|
|||
|
||||
## Warning state
|
||||
|
||||
Set `warn` to `true` and provide `warnText` to show a warning message.
|
||||
|
||||
<ComboBox warn warnText="This contact method is not associated with your account" titleText="Contact" placeholder="Select contact method"
|
||||
items={[
|
||||
{id: "0", text: "Slack"},
|
||||
|
|
@ -153,8 +120,6 @@ items={[
|
|||
|
||||
## Disabled state
|
||||
|
||||
Set `disabled` to `true` to prevent interaction with the combobox.
|
||||
|
||||
<ComboBox disabled titleText="Contact" placeholder="Select contact method"
|
||||
items={[
|
||||
{id: "0", text: "Slack"},
|
||||
|
|
@ -164,7 +129,7 @@ items={[
|
|||
|
||||
## Disabled items
|
||||
|
||||
Set `disabled: true` in an item object to disable specific options.
|
||||
Use the `disabled` property in the `items` prop to disable specific items.
|
||||
|
||||
<ComboBox
|
||||
titleText="Contact"
|
||||
|
|
|
|||
|
|
@ -6,16 +6,12 @@ components: ["ComposedModal", "ModalHeader", "ModalBody", "ModalFooter"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`ComposedModal` lets you build custom modals by combining `ModalHeader`, `ModalBody`, and `ModalFooter` components. Use it to create focused interactions that require user attention or input.
|
||||
|
||||
## Composed modal
|
||||
|
||||
Create a modal with a header, body, and footer. Each section can be customized independently.
|
||||
|
||||
<FileSource src="/framed/Modal/ComposedModal" />
|
||||
|
||||
## Multiple secondary buttons
|
||||
|
||||
Set `secondaryButtons` in `ModalFooter` to create a 3-button modal. This prop replaces `secondaryButtonText` and takes a tuple of two button configurations.
|
||||
Use the `secondaryButtons` prop in `ModalFooter` to render two secondary buttons for a "3-button modal". The prop is a 2-tuple type that supersedes `secondaryButtonText`.
|
||||
|
||||
<FileSource src="/framed/Modal/3ButtonComposedModal" />
|
||||
|
|
@ -9,12 +9,8 @@ components: ["ContentSwitcher", "Switch"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`ContentSwitcher` lets users switch between different views or sections of content. Use it to organize related content into distinct categories or states.
|
||||
|
||||
## Default
|
||||
|
||||
Create a content switcher with `Switch` components. Each switch needs a `text` prop.
|
||||
|
||||
<ContentSwitcher>
|
||||
<Switch text="Latest news" />
|
||||
<Switch text="Trending" />
|
||||
|
|
@ -22,8 +18,6 @@ Create a content switcher with `Switch` components. Each switch needs a `text` p
|
|||
|
||||
## Initial selected index
|
||||
|
||||
Set `selectedIndex` to pre-select a switch when the content switcher loads.
|
||||
|
||||
<ContentSwitcher selectedIndex={1}>
|
||||
<Switch text="Latest news" />
|
||||
<Switch text="Trending" />
|
||||
|
|
@ -32,16 +26,10 @@ Set `selectedIndex` to pre-select a switch when the content switcher loads.
|
|||
|
||||
## Reactive example
|
||||
|
||||
This example demonstrates how to programmatically control the content switcher using
|
||||
the `bind:selectedIndex` directive. Update the selected index based on user
|
||||
interactions or application state.
|
||||
|
||||
<FileSource src="/framed/ContentSwitcher/ContentSwitcherReactive" />
|
||||
|
||||
## Custom switch slot
|
||||
|
||||
Override the default slot in `Switch` to customize how each option displays.
|
||||
|
||||
<ContentSwitcher>
|
||||
<Switch>
|
||||
<div style="display: flex; align-items: center;">
|
||||
|
|
@ -55,19 +43,15 @@ Override the default slot in `Switch` to customize how each option displays.
|
|||
</Switch>
|
||||
</ContentSwitcher>
|
||||
|
||||
## Extra-large size
|
||||
## Large size
|
||||
|
||||
Set `size` to `"xl"` for an extra-large content switcher.
|
||||
|
||||
<ContentSwitcher size="xl">
|
||||
<ContentSwitcher size="lg">
|
||||
<Switch text="All" />
|
||||
<Switch text="Archived" />
|
||||
</ContentSwitcher>
|
||||
|
||||
## Small size
|
||||
|
||||
Set `size` to `"sm"` for a small content switcher.
|
||||
|
||||
<ContentSwitcher size="sm">
|
||||
<Switch text="All" />
|
||||
<Switch text="Archived" />
|
||||
|
|
@ -75,8 +59,6 @@ Set `size` to `"sm"` for a small content switcher.
|
|||
|
||||
## Disabled
|
||||
|
||||
Set `disabled` to `true` on individual switches to prevent interaction.
|
||||
|
||||
<ContentSwitcher>
|
||||
<Switch disabled text="All" />
|
||||
<Switch disabled text="Archived" />
|
||||
|
|
|
|||
|
|
@ -6,32 +6,26 @@ components: ["ContextMenu", "ContextMenuGroup", "ContextMenuRadioGroup", "Contex
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`ContextMenu` displays a menu when users right-click. Use it to provide quick access to contextual actions or options.
|
||||
|
||||
In the examples, right click anywhere within the iframe.
|
||||
|
||||
## Default
|
||||
|
||||
The context menu appears when right-clicking anywhere in the window. Use `ContextMenuOption` for menu items and `ContextMenuDivider` for visual separation.
|
||||
By default, the context menu will trigger when right clicking anywhere in the `window`.
|
||||
|
||||
<FileSource src="/framed/ContextMenu/ContextMenu" />
|
||||
|
||||
## Custom target
|
||||
|
||||
By default, the context menu will trigger when right clicking anywhere in the `window`.
|
||||
|
||||
Set `target` to specify which element triggers the context menu.
|
||||
Specify a custom `HTMLElement` using the `target` prop.
|
||||
|
||||
<FileSource src="/framed/ContextMenu/ContextMenuTarget" />
|
||||
|
||||
## Multiple targets
|
||||
|
||||
Set `target` to an array of elements to trigger the context menu from multiple sources.
|
||||
The `target` prop also accepts an array of elements.
|
||||
|
||||
<FileSource src="/framed/ContextMenu/ContextMenuTargets" />
|
||||
|
||||
## Radio groups
|
||||
|
||||
Use `ContextMenuGroup` and `ContextMenuRadioGroup` to organize related options and create radio button selections.
|
||||
|
||||
<FileSource src="/framed/ContextMenu/ContextMenuGroups" />
|
||||
|
|
@ -3,32 +3,30 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`CopyButton` lets users copy text to their clipboard with a single click. Use it to provide quick access to code snippets, links, or other text content.
|
||||
This component uses the native, asynchronous [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard/writeText) to copy text.
|
||||
|
||||
This component uses the native [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard/writeText) to copy text. Override the default copy functionality with your own implementation. See [Overriding copy functionality](#overriding-copy-functionality).
|
||||
Please note that the `clipboard.writeText` API is not supported in [IE 11 nor Safari iOS version 13.3 or lower](https://caniuse.com/mdn-api_clipboard_writetext).
|
||||
|
||||
You can override the default copy functionality with your own implementation. See [Overriding copy functionality](#overriding-copy-functionality).
|
||||
|
||||
## Default
|
||||
|
||||
Create a copy button with the `text` prop to specify what to copy.
|
||||
|
||||
<CopyButton text="Carbon svelte" />
|
||||
|
||||
## Custom feedback text
|
||||
|
||||
Set `feedback` to customize the message shown after copying.
|
||||
|
||||
<CopyButton text="Carbon svelte" feedback="Copied to clipboard" />
|
||||
|
||||
## Overriding copy functionality
|
||||
|
||||
Pass a custom function to the `copy` prop to override the default copy behavior.
|
||||
To override the default copy behavior, pass a custom function to the `copy` prop.
|
||||
|
||||
This example uses the NPM package [clipboard-copy](https://github.com/feross/clipboard-copy) to copy the text instead of the default Clipboard API.
|
||||
In this example, we use the open source module [clipboard-copy](https://github.com/feross/clipboard-copy) to copy the text instead of the default Clipboard API.
|
||||
|
||||
<FileSource src="/framed/CopyButton/CopyButtonOverride" />
|
||||
|
||||
## Preventing copy functionality
|
||||
|
||||
Pass a no-op function to the `copy` prop to disable copying.
|
||||
To prevent text from being copied entirely, pass a no-op function to the `copy` prop.
|
||||
|
||||
<CopyButton text="This text should not be copied" copy={() => {}} />
|
||||
|
|
@ -8,20 +8,21 @@ components: ["DataTable", "Pagination","Toolbar", "ToolbarContent", "ToolbarSear
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`DataTable` displays structured data in a tabular format. Use it to present large datasets with features like sorting, filtering, pagination, and row selection.
|
||||
`DataTable` is keyed for performance reasons.
|
||||
|
||||
<InlineNotification svx-ignore lowContrast title="Note:" kind="info" hideCloseButton>
|
||||
<div class="body-short-01">
|
||||
This component is keyed for performance.
|
||||
<div class="body-short-01">Every <code>headers</code> object must have a unique "key" property.</div>
|
||||
</InlineNotification>
|
||||
|
||||
Every <strong>headers</strong> object must have a unique "key" property.
|
||||
<div class="body-short-01">Every <strong>rows</strong> object must have a unique "id" property.</div>
|
||||
</div>
|
||||
<InlineNotification svx-ignore lowContrast title="Note:" kind="info" hideCloseButton>
|
||||
<div class="body-short-01">Every <code>rows</code> object must have a unique "id" property.</div>
|
||||
</InlineNotification>
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic table by providing `headers` and `rows` data. Match the `key` in headers with the corresponding property in rows.
|
||||
The key value in `headers` corresponds to the key value defined in `rows`.
|
||||
|
||||
For example, the header key `"name"` will use the value of `rows[index].name`.
|
||||
|
||||
<DataTable
|
||||
headers="{[
|
||||
|
|
@ -78,7 +79,9 @@ Create a basic table by providing `headers` and `rows` data. Match the `key` in
|
|||
|
||||
## Slotted cells
|
||||
|
||||
Use the `"cell"` slot to customize cell content. Access row and cell data through `let:row` and `let:cell` directives. Use `"cell-header"` slot for header cells.
|
||||
Use the `"cell"` slot to control the display value per table cell. Individual row and cell data are provided through the `let:row` and `let:cell` directives.
|
||||
|
||||
The slot name for the table header cells is `"cell-header"`.
|
||||
|
||||
<DataTable
|
||||
headers="{[
|
||||
|
|
@ -150,8 +153,6 @@ Use the `"cell"` slot to customize cell content. Access row and cell data throug
|
|||
|
||||
## With title, description
|
||||
|
||||
Add a title and description to provide context for the table data.
|
||||
|
||||
<DataTable title="Load balancers" description="Your organization's active load balancers."
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -207,7 +208,7 @@ Add a title and description to provide context for the table data.
|
|||
|
||||
## Slottable title, description
|
||||
|
||||
Use slots to customize the title and description content.
|
||||
The `title` and `description` props are slottable.
|
||||
|
||||
<DataTable
|
||||
headers="{[
|
||||
|
|
@ -269,7 +270,7 @@ Use slots to customize the title and description content.
|
|||
|
||||
## Static width
|
||||
|
||||
Set `useStaticWidth` to `true` to render the table with an auto width instead of 100%.
|
||||
Set `useStaticWidth` to `true` to render the table with a width of "auto" instead of "100%".
|
||||
|
||||
<DataTable useStaticWidth
|
||||
title="Load balancers" description="Your organization's active load balancers."
|
||||
|
|
@ -327,7 +328,9 @@ title="Load balancers" description="Your organization's active load balancers."
|
|||
|
||||
## Custom column widths
|
||||
|
||||
Specify `width` or `minWidth` in the `headers` object to set column dimensions. This applies a fixed table layout.
|
||||
Specify a `width` or `minWidth` property in the `headers` object to customize the width of each column.
|
||||
|
||||
A [table-layout: fixed](https://developer.mozilla.org/en-US/docs/Web/CSS/table-layout#values) rule will be applied to the `table` element when using custom widths.
|
||||
|
||||
<InlineNotification svx-ignore lowContrast kind="warning" title="Note:" hideCloseButton>
|
||||
<div class="body-short-01">Custom column widths do not work with a <a class="bx--link" href="#sticky-header">sticky header</a>.</div>
|
||||
|
|
@ -337,7 +340,9 @@ Specify `width` or `minWidth` in the `headers` object to set column dimensions.
|
|||
|
||||
## Sticky header
|
||||
|
||||
Set `stickyHeader` to `true` to fix the header in place. This adds a maximum height to force scrolling.
|
||||
Set `stickyHeader` to `true` for the header to be fixed in place.
|
||||
|
||||
A maximum height will applied to the datatable to force a scrollbar.
|
||||
|
||||
<DataTable
|
||||
stickyHeader
|
||||
|
|
@ -358,8 +363,6 @@ Set `stickyHeader` to `true` to fix the header in place. This adds a maximum hei
|
|||
|
||||
## With toolbar
|
||||
|
||||
Add a toolbar with search, menu, and actions above the table.
|
||||
|
||||
<DataTable title="Load balancers" description="Your organization's active load balancers."
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -429,8 +432,6 @@ Add a toolbar with search, menu, and actions above the table.
|
|||
|
||||
## With toolbar (small size)
|
||||
|
||||
Use `size="short"` to create a more compact table with a small toolbar.
|
||||
|
||||
<DataTable size="short" title="Load balancers" description="Your organization's active load balancers."
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -498,22 +499,24 @@ Use `size="short"` to create a more compact table with a small toolbar.
|
|||
|
||||
## Filterable
|
||||
|
||||
Set `shouldFilterRows` to `true` to enable client-side filtering. The default filter performs string comparisons on cell values.
|
||||
By default, `ToolbarSearch` will not filter `DataTable` rows.
|
||||
|
||||
For pagination with filtering, bind to `filteredRowIds` and pass its length to `Pagination`'s `totalItems`.
|
||||
Set `shouldFilterRows` to `true` to enable client-side filtering. The default filtering performs a basic string comparison on cell values that are of a string or a number type.
|
||||
|
||||
To use filtering with pagination, bind to the `filteredRowIds` prop and pass its length to `totalItems` in `Pagination`.
|
||||
|
||||
Note that in-memory filtering is not optimal for large data sets, where you might consider using server-side search.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTableFilterable" />
|
||||
|
||||
## Filterable (custom)
|
||||
|
||||
Pass a function to `shouldFilterRows` to implement custom filtering logic.
|
||||
`shouldFilterRows` also accepts a function and passes it the current row and search value. It expects the function to return a boolean.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTableFilterCustom" />
|
||||
|
||||
## Zebra stripes
|
||||
|
||||
Set `zebra` to `true` to add alternating row colors.
|
||||
|
||||
<DataTable zebra
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -569,8 +572,6 @@ Set `zebra` to `true` to add alternating row colors.
|
|||
|
||||
## Tall rows
|
||||
|
||||
Set `size="tall"` for increased row height.
|
||||
|
||||
<DataTable size="tall"
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -626,8 +627,6 @@ Set `size="tall"` for increased row height.
|
|||
|
||||
## Medium rows
|
||||
|
||||
Set `size="medium"` for standard row height.
|
||||
|
||||
<DataTable size="medium"
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -683,8 +682,6 @@ Set `size="medium"` for standard row height.
|
|||
|
||||
## Short rows
|
||||
|
||||
Set `size="short"` for compact row height.
|
||||
|
||||
<DataTable size="short"
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -740,8 +737,6 @@ Set `size="short"` for compact row height.
|
|||
|
||||
## Compact rows
|
||||
|
||||
Set `size="compact"` for minimal row height.
|
||||
|
||||
<DataTable size="compact"
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -797,7 +792,11 @@ Set `size="compact"` for minimal row height.
|
|||
|
||||
## Sortable
|
||||
|
||||
Set `sortable` to `true` to enable column sorting. Disable sorting on specific columns by setting `sort: false` in the header object.
|
||||
Set `sortable` to `true` to enable table column sorting.
|
||||
|
||||
To disable sorting on a specific column, set `sort` to `false` in the header object passed to the `headers` prop.
|
||||
|
||||
In the example below, the "Protocol" column is not sortable.
|
||||
|
||||
<DataTable sortable
|
||||
headers="{[
|
||||
|
|
@ -854,14 +853,12 @@ Set `sortable` to `true` to enable column sorting. Disable sorting on specific c
|
|||
|
||||
## Sortable with pagination
|
||||
|
||||
Bind to `pageSize` and `page` props of `Pagination` and pass them to `DataTable`.
|
||||
For pagination, bind to the `pageSize` and `page` props of `Pagination` and pass their values to `DataTable`.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTablePagination" />
|
||||
|
||||
## Sortable with custom display and sort methods
|
||||
|
||||
Use `display` and `sort` functions in header objects to customize cell rendering and sorting.
|
||||
|
||||
<DataTable sortable title="Load balancers" description="Your organization's active load balancers."
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -929,8 +926,6 @@ Use `display` and `sort` functions in header objects to customize cell rendering
|
|||
|
||||
## Sortable with nested object values
|
||||
|
||||
Access nested object properties using dot notation in the header key.
|
||||
|
||||
<DataTable sortable title="Load balancers" description="Your organization's active load balancers."
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -1010,61 +1005,71 @@ Access nested object properties using dot notation in the header key.
|
|||
|
||||
## Programmatic sorting
|
||||
|
||||
Use `sortKey` and `sortDirection` props to control sorting programmatically. Set `sortKey` to a valid header key and `sortDirection` to "none", "ascending", or "descending".
|
||||
Use the reactive `sortKey` and `sortDirection` props for programmatic sorting.
|
||||
|
||||
By default, the table is not sorted by a specific key. The `sortKey` value must be a valid `key` specified in the `headers` object.
|
||||
|
||||
Possible values for `sortDirection` include `"none"` or `"ascending"` or `"descending"`.
|
||||
|
||||
Setting `sortKey` to `null` and `sortDirection` to `"none"` should reset the table rows to their initial order.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTableProgrammaticSorting" />
|
||||
|
||||
## Empty column with overflow menu
|
||||
|
||||
Set `empty: true` in a header object to create an empty column. Use this for overflow menus without a header.
|
||||
Some use cases require an empty column in the table body without a corresponding table header.
|
||||
|
||||
For an object in the `headers` array, set `empty` to `true` to render an empty column.
|
||||
|
||||
In the following example, each row in the sortable data table has an overflow menu. There isn't a separate, useless table header column for the overflow menu.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTableAppendColumns" />
|
||||
|
||||
## Selectable rows (checkbox)
|
||||
|
||||
Set `selectable` to `true` for multi-select functionality. Bind to `selectedRowIds` to track selections. Use `inputName` to customize checkbox names.
|
||||
Set `selectable` to `true` for rows to be multi-selectable.
|
||||
|
||||
<FileSource src="/framed/DataTable/SelectableDataTable" />
|
||||
|
||||
## Batch selection
|
||||
|
||||
Set `batchSelection` to `true` to add a checkbox for selecting all rows. The checkbox shows an indeterminate state when some rows are selected.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTableBatchSelection" />
|
||||
|
||||
## Batch selection with initial selected rows
|
||||
|
||||
Use `selectedRowIds` to specify initially selected rows.
|
||||
Use the `selectedRowIds` prop to specify which rows should be selected.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTableBatchSelectionInitial" />
|
||||
|
||||
## Batch selection with batch actions toolbar
|
||||
|
||||
Add a toolbar for batch actions when rows are selected.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTableBatchSelectionToolbar" />
|
||||
|
||||
## Batch selection with controlled toolbar
|
||||
|
||||
Control the batch actions toolbar with the `active` prop. Prevent default cancel behavior in the `on:cancel` event.
|
||||
By default, `ToolbarBatchActions` is activated if one or more rows is selected. Clicking "Cancel" will deactivate it.
|
||||
|
||||
Use the `active` prop to control the toolbar. Note that it will still activate if one or more rows are selected.
|
||||
|
||||
You can also prevent the default "Cancel" behavior in the dispatched `on:cancel` event.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTableBatchSelectionToolbarControlled" />
|
||||
|
||||
## Selectable rows (radio)
|
||||
|
||||
Set `radio` to `true` for single-row selection. Bind to `selectedRowIds` to track the selected row. Use `inputName` to customize radio button names.
|
||||
Set `radio` to `true` for only one row to be selected at a time.
|
||||
|
||||
<FileSource src="/framed/DataTable/RadioSelectableDataTable" />
|
||||
|
||||
## Non-selectable rows
|
||||
|
||||
Use `nonSelectableRowIds` to prevent selection of specific rows.
|
||||
Use `nonSelectableRowIds` to specify the ids for rows that should not be selectable.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTableNonSelectableRows" />
|
||||
|
||||
## Expandable rows
|
||||
|
||||
Set `expandable` to `true` to make rows expandable. Use the `expanded-row` slot to customize expanded content.
|
||||
Set `expandable` to `true` for rows to be expandable.
|
||||
|
||||
<DataTable expandable
|
||||
headers="{[
|
||||
|
|
@ -1125,20 +1130,16 @@ Set `expandable` to `true` to make rows expandable. Use the `expanded-row` slot
|
|||
|
||||
## Non-expandable rows
|
||||
|
||||
Use `nonExpandableRowIds` to prevent expansion of specific rows.
|
||||
Use `nonExpandableRowIds` to specify the ids for rows that should not be expandable.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTableNonExpandableRows" />
|
||||
|
||||
## Expandable (zebra styles)
|
||||
|
||||
Combine expandable rows with zebra striping.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTableExpandableZebra" />
|
||||
|
||||
## Expandable (compact size)
|
||||
|
||||
Set `size="compact"` for expandable rows with minimal height.
|
||||
|
||||
<DataTable size="compact" expandable
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -1198,8 +1199,6 @@ Set `size="compact"` for expandable rows with minimal height.
|
|||
|
||||
## Expandable (short size)
|
||||
|
||||
Set `size="short"` for expandable rows with compact height.
|
||||
|
||||
<DataTable size="short" expandable
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -1259,8 +1258,6 @@ Set `size="short"` for expandable rows with compact height.
|
|||
|
||||
## Expandable (tall size)
|
||||
|
||||
Set `size="tall"` for expandable rows with increased height.
|
||||
|
||||
<DataTable size="tall" expandable
|
||||
headers="{[
|
||||
{ key: "name", value: "Name" },
|
||||
|
|
@ -1320,7 +1317,7 @@ Set `size="tall"` for expandable rows with increased height.
|
|||
|
||||
## Batch expansion
|
||||
|
||||
Set `batchExpansion` to `true` to expand and collapse all rows at once.
|
||||
Set `batchExpansion` to `true` for the ability to expand and collapse all rows at once.
|
||||
|
||||
<DataTable batchExpansion
|
||||
headers="{[
|
||||
|
|
@ -1381,54 +1378,42 @@ Set `batchExpansion` to `true` to expand and collapse all rows at once.
|
|||
|
||||
## Expandable and selectable rows
|
||||
|
||||
Combine `batchExpansion` and `batchSelection` for tables with both expandable and selectable rows.
|
||||
The `batchExpansion` and `batchSelection` props can be used together.
|
||||
|
||||
<FileSource src="/framed/DataTable/DataTableExpandableSelectable" />
|
||||
|
||||
## Skeleton
|
||||
|
||||
Use `DataTableSkeleton` to show a loading state.
|
||||
|
||||
<DataTableSkeleton />
|
||||
|
||||
## Skeleton with headers, row count
|
||||
|
||||
Specify headers and row count for the skeleton.
|
||||
|
||||
<DataTableSkeleton headers={["Name", "Protocol", "Port", "Rule"]} rows={10} />
|
||||
|
||||
## Skeleton with object headers
|
||||
|
||||
Pass header objects to customize the skeleton.
|
||||
`headers` can also be an array of objects. The type is the same as the `headers` prop type used in `DataTable`.
|
||||
|
||||
<DataTableSkeleton headers={[{ value: "Name" }, {value: "Protocol"}, {value:"Port"}, { value: "Rule"}]} rows={10} />
|
||||
|
||||
## Skeleton with empty header
|
||||
|
||||
Add an empty header column with `empty: true`.
|
||||
Pass an object with `"empty"` set to `true` to render an empty table header column.
|
||||
|
||||
<DataTableSkeleton headers={[{ value: "Name" }, {value: "Protocol"}, {value:"Port"}, { value: "Rule"}, { empty: true }]} rows={10} />
|
||||
|
||||
## Skeleton without header, toolbar
|
||||
|
||||
Hide the header and toolbar in the skeleton.
|
||||
|
||||
<DataTableSkeleton showHeader={false} showToolbar={false} />
|
||||
|
||||
## Skeleton (tall size)
|
||||
|
||||
Set `size="tall"` for a taller skeleton.
|
||||
|
||||
<DataTableSkeleton showHeader={false} showToolbar={false} size="tall" />
|
||||
|
||||
## Skeleton (short size)
|
||||
|
||||
Set `size="short"` for a shorter skeleton.
|
||||
|
||||
<DataTableSkeleton showHeader={false} showToolbar={false} size="short" />
|
||||
|
||||
## Skeleton (compact size)
|
||||
|
||||
Set `size="compact"` for a minimal skeleton.
|
||||
|
||||
<DataTableSkeleton showHeader={false} showToolbar={false} size="compact" />
|
||||
|
|
@ -7,7 +7,11 @@ components: ["DatePicker", "DatePickerInput", "DatePickerSkeleton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`DatePicker` lets users select a date or date range using a calendar interface. It uses the [flatpickr](https://github.com/flatpickr/flatpickr) library for its calendar implementation.
|
||||
Carbon uses the zero dependency [flatpickr](https://github.com/flatpickr/flatpickr) library for its underlying calendar implementation.
|
||||
|
||||
Set `datePickerType` to `"single"` or `"range"` for the calendar functionality.
|
||||
|
||||
Specify [flatpickr options](https://flatpickr.js.org/options/) through the `flatpickrProps` prop.
|
||||
|
||||
<InlineNotification svx-ignore lowContrast title="Note:" kind="info" hideCloseButton>
|
||||
<div class="body-short-01">
|
||||
|
|
@ -17,27 +21,25 @@ components: ["DatePicker", "DatePickerInput", "DatePickerSkeleton"]
|
|||
|
||||
## Single
|
||||
|
||||
Set `datePickerType` to `"single"` for single date selection.
|
||||
By default, the `flatpickr` option `static` is set to `true` so that the calendar is positioned inside the wrapper and next to the input element. This is required for the calendar position to work inside a [Modal](/components/Modal).
|
||||
|
||||
Set `flatpickrProps.static` to `false` to opt out of this behavior.
|
||||
|
||||
<FileSource src="/framed/DatePicker/DatePickerSingle" />
|
||||
|
||||
## Range
|
||||
|
||||
Set `datePickerType` to `"range"` to enable date range selection.
|
||||
Set `datePickerType` to `"range"` for the range variant.
|
||||
|
||||
<FileSource src="/framed/DatePicker/DatePickerRange" />
|
||||
|
||||
## DatePicker in a modal
|
||||
|
||||
The calendar is positioned inside the wrapper by default (`flatpickrProps.static: true`). This ensures proper positioning within a [Modal](/components/Modal).
|
||||
|
||||
Set `flatpickrProps.static` to `false` to position the calendar outside the wrapper.
|
||||
|
||||
<FileSource src="/framed/DatePicker/DatePickerModal" />
|
||||
|
||||
## Simple
|
||||
|
||||
Create a simple date picker without a dropdown calendar.
|
||||
By default, the "simple" date picker does not have a dropdown calendar.
|
||||
|
||||
<DatePicker>
|
||||
<DatePickerInput labelText="Date of birth" placeholder="mm/dd/yyyy" />
|
||||
|
|
@ -45,70 +47,52 @@ Create a simple date picker without a dropdown calendar.
|
|||
|
||||
## With helper text
|
||||
|
||||
Add helper text to provide additional context or formatting instructions.
|
||||
|
||||
<DatePicker>
|
||||
<DatePickerInput labelText="Date of birth" helperText="Example: 01/12/1990" placeholder="mm/dd/yyyy" />
|
||||
</DatePicker>
|
||||
|
||||
## Hidden label
|
||||
|
||||
Hide the label while maintaining accessibility.
|
||||
|
||||
<DatePicker>
|
||||
<DatePickerInput hideLabel labelText="Date of birth" placeholder="mm/dd/yyyy" />
|
||||
</DatePicker>
|
||||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for light backgrounds.
|
||||
|
||||
<DatePicker light>
|
||||
<DatePickerInput labelText="Date of birth" placeholder="mm/dd/yyyy" />
|
||||
</DatePicker>
|
||||
|
||||
## Extra-large size
|
||||
|
||||
Use the extra-large size for more prominent date pickers.
|
||||
## Large size
|
||||
|
||||
<DatePicker>
|
||||
<DatePickerInput size="xl" labelText="Date of birth" placeholder="mm/dd/yyyy" />
|
||||
<DatePickerInput size="lg" labelText="Date of birth" placeholder="mm/dd/yyyy" />
|
||||
</DatePicker>
|
||||
|
||||
## Small size
|
||||
|
||||
Use the small size for compact date pickers.
|
||||
|
||||
<DatePicker>
|
||||
<DatePickerInput size="sm" labelText="Date of birth" placeholder="mm/dd/yyyy" />
|
||||
</DatePicker>
|
||||
|
||||
## Invalid state
|
||||
|
||||
Show an invalid state when the input value is not valid.
|
||||
|
||||
<DatePicker>
|
||||
<DatePickerInput invalid invalidText="Invalid date" labelText="Date of birth" placeholder="mm/dd/yyyy" />
|
||||
</DatePicker>
|
||||
|
||||
## Warning state
|
||||
|
||||
Show a warning state to indicate potential issues with the input.
|
||||
|
||||
<DatePicker>
|
||||
<DatePickerInput warn warnText="This info will not be stored" labelText="Date of birth" placeholder="mm/dd/yyyy" />
|
||||
</DatePicker>
|
||||
|
||||
## Disabled state
|
||||
|
||||
Disable the date picker to prevent user interaction.
|
||||
|
||||
<DatePicker>
|
||||
<DatePickerInput disabled labelText="Date of birth" placeholder="mm/dd/yyyy" />
|
||||
</DatePicker>
|
||||
|
||||
## Skeleton
|
||||
|
||||
Show a loading state with the skeleton component.
|
||||
|
||||
<DatePickerSkeleton />
|
||||
|
|
|
|||
|
|
@ -7,9 +7,7 @@ components: ["Dropdown", "DropdownSkeleton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `Dropdown` component provides a select input with a dropdown menu. It supports
|
||||
various states, sizes, and customization options. Each item in the dropdown must
|
||||
have a unique `id` property for proper functionality.
|
||||
`Dropdown` is keyed for performance reasons.
|
||||
|
||||
<InlineNotification svx-ignore lowContrast title="Note:" kind="info" hideCloseButton>
|
||||
<div class="body-short-01">Every <code>items</code> object must have a unique "id" property.</div>
|
||||
|
|
@ -17,33 +15,25 @@ have a unique `id` property for proper functionality.
|
|||
|
||||
## Default
|
||||
|
||||
Use the `Dropdown` component to create a select input with a dropdown menu. Each item
|
||||
must have a unique `id` property.
|
||||
|
||||
<Dropdown titleText="Contact" selectedId="0" items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}" />
|
||||
|
||||
## Custom slot
|
||||
|
||||
Override the default slot to customize the display of each item. Access the item and
|
||||
index through the `let:` directive.
|
||||
Override the default slot to customize the display of each item. Access the item and index through the `let:` directive.
|
||||
|
||||
<FileSource src="/framed/Dropdown/DropdownSlot" />
|
||||
|
||||
## Hidden label
|
||||
|
||||
Hide the label while maintaining accessibility by setting the `hideLabel` prop to
|
||||
`true`. The label will still be available to screen readers.
|
||||
|
||||
<Dropdown hideLabel titleText="Contact" selectedId="0" items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}" />
|
||||
|
||||
## Format item display text
|
||||
|
||||
Format the display text of items using the `itemToString` prop. This function
|
||||
receives the item object and returns the formatted string.
|
||||
Use the `itemToString` prop to format the display of individual items.
|
||||
|
||||
<Dropdown itemToString={item => {
|
||||
return item.text + ' (' + item.id +')'
|
||||
|
|
@ -53,15 +43,11 @@ receives the item object and returns the formatted string.
|
|||
|
||||
## Multiple dropdowns
|
||||
|
||||
Create multiple dropdowns that work together. This example demonstrates how to
|
||||
manage the state of multiple dropdowns.
|
||||
|
||||
<FileSource src="/framed/Dropdown/MultipleDropdown" />
|
||||
|
||||
## Top direction
|
||||
|
||||
Display the dropdown menu above the input by setting the `direction` prop to
|
||||
`"top"`. This is useful when there's limited space below the input.
|
||||
Set `direction` to `"top"` for the dropdown menu to appear above the input.
|
||||
|
||||
<Dropdown direction="top" titleText="Contact" selectedId="0" items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
|
|
@ -69,72 +55,49 @@ Display the dropdown menu above the input by setting the `direction` prop to
|
|||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for dropdowns on dark backgrounds by setting the `light` prop
|
||||
to `true`.
|
||||
|
||||
<Dropdown light titleText="Contact" selectedId="0" items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}" />
|
||||
|
||||
## Inline variant
|
||||
|
||||
Display the dropdown inline with other content by setting the `type` prop to
|
||||
`"inline"`. This variant removes the background and border.
|
||||
|
||||
<Dropdown type="inline" titleText="Contact" selectedId="0" items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}" />
|
||||
|
||||
## Extra-large size
|
||||
## Large size
|
||||
|
||||
Increase the size of the dropdown by setting the `size` prop to `"xl"`. This
|
||||
provides more visual emphasis for important selections.
|
||||
|
||||
<Dropdown size="xl" titleText="Contact" selectedId="0" items="{[{id: "0", text: "Slack"},
|
||||
<Dropdown size="lg" titleText="Contact" selectedId="0" items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}" />
|
||||
|
||||
## Small size
|
||||
|
||||
Decrease the size of the dropdown by setting the `size` prop to `"sm"`. This is
|
||||
useful for compact layouts or secondary selections.
|
||||
|
||||
<Dropdown size="sm" titleText="Contact" selectedId="0" items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}" />
|
||||
|
||||
## Invalid state
|
||||
|
||||
Indicate an invalid selection by setting the `invalid` prop to `true`. Provide
|
||||
feedback to users with the `invalidText` prop.
|
||||
|
||||
<Dropdown invalid invalidText="Secondary contact method must be different from the primary contact" titleText="Contact" selectedId="0" items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}" />
|
||||
|
||||
## Warning state
|
||||
|
||||
Indicate a warning state by setting the `warn` prop to `true`. Provide additional
|
||||
context with the `warnText` prop.
|
||||
|
||||
<Dropdown warn warnText="This contact method is not associated with your account" titleText="Contact" selectedId="0" items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}" />
|
||||
|
||||
## Disabled state
|
||||
|
||||
Disable the entire dropdown by setting the `disabled` prop to `true`. This prevents
|
||||
user interaction with the component.
|
||||
|
||||
<Dropdown disabled titleText="Contact" selectedId="0" items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}" />
|
||||
|
||||
## Disabled items
|
||||
|
||||
Disable specific items in the dropdown by setting the `disabled` property to
|
||||
`true` in the item object. This allows for more granular control over available
|
||||
selections.
|
||||
Use the `disabled` property in the `items` prop to disable specific items.
|
||||
|
||||
<Dropdown
|
||||
selectedId="0"
|
||||
|
|
@ -148,7 +111,4 @@ selections.
|
|||
|
||||
## Skeleton
|
||||
|
||||
Display a loading state using the `DropdownSkeleton` component. This provides
|
||||
visual feedback while the dropdown content is being loaded.
|
||||
|
||||
<DropdownSkeleton />
|
||||
|
|
@ -3,19 +3,11 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `ExpandableTile` component creates a collapsible content container that can
|
||||
show and hide content with a smooth animation. It's ideal for managing content
|
||||
overflow and progressive disclosure of information. The component automatically
|
||||
measures content height using a resize observer.
|
||||
|
||||
## Default
|
||||
|
||||
Create an expandable tile that shows and hides content. The component uses a
|
||||
[resize observer](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
|
||||
to determine the height of the above-the-fold content.
|
||||
This component uses a [resize observer](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver) to determine the height of the above-the-fold content.
|
||||
|
||||
By default, the tile is collapsed. Use the `above` and `below` slots to define the
|
||||
content that appears before and after expansion.
|
||||
It's unexpanded by default.
|
||||
|
||||
<ExpandableTile>
|
||||
<div slot="above">
|
||||
|
|
@ -33,8 +25,7 @@ content that appears before and after expansion.
|
|||
|
||||
## Custom tile heights
|
||||
|
||||
Set custom heights for the tile content using CSS. This is useful when you need to
|
||||
control the exact dimensions of the visible and hidden content.
|
||||
Set a custom height for the tiles on the "above" and "below" slots.
|
||||
|
||||
<ExpandableTile>
|
||||
<div slot="above" style="height: 10rem">Above the fold content here</div>
|
||||
|
|
@ -43,9 +34,6 @@ control the exact dimensions of the visible and hidden content.
|
|||
|
||||
## Expanded
|
||||
|
||||
Display the tile in its expanded state by default by setting the `expanded` prop to
|
||||
`true`.
|
||||
|
||||
<ExpandableTile expanded>
|
||||
<div slot="above">Above the fold content here</div>
|
||||
<div slot="below">Below the fold content here</div>
|
||||
|
|
@ -53,9 +41,6 @@ Display the tile in its expanded state by default by setting the `expanded` prop
|
|||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for expandable tiles on dark backgrounds by setting the
|
||||
`light` prop to `true`.
|
||||
|
||||
<ExpandableTile light>
|
||||
<div slot="above">Above the fold content here</div>
|
||||
<div slot="below">Below the fold content here</div>
|
||||
|
|
@ -63,9 +48,6 @@ Use the light variant for expandable tiles on dark backgrounds by setting the
|
|||
|
||||
## With icon labels
|
||||
|
||||
Customize the expand/collapse button labels using the `tileExpandedLabel` and
|
||||
`tileCollapsedLabel` props.
|
||||
|
||||
<ExpandableTile tileExpandedLabel="View less" tileCollapsedLabel="View more">
|
||||
<div slot="above">Above the fold content here</div>
|
||||
<div slot="below">Below the fold content here</div>
|
||||
|
|
@ -73,12 +55,10 @@ Customize the expand/collapse button labels using the `tileExpandedLabel` and
|
|||
|
||||
## With interactive content
|
||||
|
||||
Handle interactive content within the tile by preventing event propagation. This
|
||||
ensures that clicks on interactive elements don't trigger the tile's expand/collapse
|
||||
behavior.
|
||||
For tiles containing interactive content, use `stopPropagation` to prevent the tile from toggling.
|
||||
|
||||
<ExpandableTile tileExpandedLabel="View less" tileCollapsedLabel="View more">
|
||||
<div slot="above">
|
||||
<div slot="above" height="10rem">
|
||||
<a href="/" on:click|preventDefault|stopPropagation={() => console.log("Hello world")}>
|
||||
Native element
|
||||
</a>
|
||||
|
|
|
|||
|
|
@ -7,28 +7,23 @@ components: ["FileUploaderButton", "FileUploader", "FileUploaderDropContainer",
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `FileUploader` components provide a complete solution for file uploads, including
|
||||
a button trigger, drag-and-drop container, and file list display. The components
|
||||
support various states, file validation, and customization options.
|
||||
|
||||
## File uploader (button-only)
|
||||
|
||||
Create a simple file upload button using `FileUploaderButton`. By default, it
|
||||
accepts a single file. Set `multiple` to `true` to allow multiple file selection.
|
||||
By default, the file uploader only accepts one file.
|
||||
|
||||
Set `multiple` to `true` for multiple files to be accepted.
|
||||
|
||||
<FileUploaderButton labelText="Add file" />
|
||||
|
||||
## Multiple files
|
||||
|
||||
Enable multiple file selection by setting the `multiple` prop to `true`. This
|
||||
allows users to select multiple files at once.
|
||||
|
||||
<FileUploaderButton multiple labelText="Add files" />
|
||||
|
||||
## Custom button kind, size
|
||||
|
||||
Customize the button appearance using the `kind` and `size` props. The default is
|
||||
a small primary button.
|
||||
By default, the `primary` small button kind is used.
|
||||
|
||||
Use the `kind` and `size` props to customize the button.
|
||||
|
||||
<FileUploaderButton kind="secondary" size="field" />
|
||||
<FileUploaderButton kind="tertiary" size="default" />
|
||||
|
|
@ -37,19 +32,19 @@ a small primary button.
|
|||
|
||||
## File uploader
|
||||
|
||||
The `FileUploader` component combines a button trigger with a list of uploaded
|
||||
files. It supports file type restrictions, multiple file selection, and various
|
||||
upload states.
|
||||
The `FileUploader` wraps `FileUploaderButton` and lists out uploaded files.
|
||||
|
||||
This example accepts multiple JPEG files and displays them in a completed state.
|
||||
The example below accepts multiple files with an extension of `.jpg` or `.jpeg`. It sets the status to `"complete"`; by default, the status is `"loading"`.
|
||||
|
||||
See the [item examples below](#item-uploading) for different statuses.
|
||||
|
||||
<FileUploader multiple labelTitle="Upload files" buttonLabel="Add files" labelDescription="Only JPEG files are accepted." accept="{['.jpg', '.jpeg']}" status="complete" />
|
||||
|
||||
## Clear files
|
||||
|
||||
Remove uploaded files from the `FileUploader` component in two ways:
|
||||
There are two ways to clear files in `FileUploader`:
|
||||
|
||||
<UnorderedList svx-ignore style="margin-bottom: var(--cds-spacing-08)">
|
||||
<UnorderedList svx-ignore style="margin-bottom: var(--bx-spacing-08)">
|
||||
<ListItem>programmatically using the <strong>clearFiles</strong> accessor</ListItem>
|
||||
<ListItem>two-way binding by setting <strong>files</strong> to <strong>[]</strong></ListItem>
|
||||
</UnorderedList>
|
||||
|
|
@ -58,29 +53,21 @@ Remove uploaded files from the `FileUploader` component in two ways:
|
|||
|
||||
## File uploader (disabled state)
|
||||
|
||||
Disable the file uploader by setting the `disabled` prop to `true`. This prevents
|
||||
user interaction with the component.
|
||||
|
||||
<FileUploader disabled multiple labelTitle="Upload files" buttonLabel="Add files" labelDescription="Only JPEG files are accepted." accept="{['.jpg', '.jpeg']}" status="complete" />
|
||||
|
||||
## Item (uploading)
|
||||
|
||||
Display a file upload in progress using the `uploading` status. This shows a
|
||||
loading indicator and the file name.
|
||||
|
||||
<FileUploaderItem name="README.md" status="uploading" />
|
||||
|
||||
## Item (complete)
|
||||
|
||||
Show a successfully uploaded file using the `complete` status. This displays a
|
||||
checkmark icon next to the file name.
|
||||
|
||||
<FileUploaderItem name="README.md" status="complete" />
|
||||
|
||||
## Item (edit)
|
||||
|
||||
Enable file deletion by setting the status to `"edit"`. Clicking the close icon
|
||||
dispatches a `delete` event with the item's ID.
|
||||
If the `status` is `"edit"`, clicking the close icon will dispatch a `delete` event.
|
||||
|
||||
The event detail contains the item `id`.
|
||||
|
||||
<FileUploaderItem id="readme" name="README.md" status="edit" on:delete={(e) => {
|
||||
console.log(e.detail); // "readme"
|
||||
|
|
@ -88,15 +75,13 @@ dispatches a `delete` event with the item's ID.
|
|||
|
||||
## Item (edit status, invalid state)
|
||||
|
||||
Mark a file as invalid while keeping it editable. This shows an error icon and
|
||||
allows the user to remove the file.
|
||||
An item can also have an edit status with an invalid state.
|
||||
|
||||
<FileUploaderItem invalid id="readme" name="README.md" status="edit" on:delete />
|
||||
|
||||
## Item (edit status, invalid state with subject, body)
|
||||
|
||||
Provide detailed error messages for invalid files using the `errorSubject` and
|
||||
`errorBody` props. This helps users understand and resolve upload issues.
|
||||
Use the `errorSubject` and `errorBody` props to customize the error message.
|
||||
|
||||
<FileUploaderItem
|
||||
invalid
|
||||
|
|
@ -110,20 +95,19 @@ Provide detailed error messages for invalid files using the `errorSubject` and
|
|||
|
||||
## Item sizes
|
||||
|
||||
Customize the size of file uploader items using the `size` prop. The default size
|
||||
is "default".
|
||||
The default `FileUploaderItem` size is "lg".
|
||||
|
||||
<FileUploaderItem size="default" name="README.md" status="uploading" />
|
||||
<FileUploaderItem size="field" name="README.md" status="uploading" />
|
||||
<FileUploaderItem size="small" name="README.md" status="uploading" />
|
||||
<FileUploaderItem size="lg" name="README.md" status="uploading" />
|
||||
<FileUploaderItem size="md" name="README.md" status="uploading" />
|
||||
<FileUploaderItem size="sm" name="README.md" status="uploading" />
|
||||
|
||||
## Drop container
|
||||
|
||||
Use `FileUploaderDropContainer` for drag-and-drop file uploads. It supports file
|
||||
validation and multiple file selection.
|
||||
The `FileUploaderDropContainer` accepts files through click and drop events.
|
||||
|
||||
This example accepts files smaller than 1 kB and logs the selected files to the
|
||||
console.
|
||||
Use the `validateFiles` prop to filter out files before they are set.
|
||||
|
||||
The following example accepts files smaller than 1 kB.
|
||||
|
||||
<FileUploaderDropContainer
|
||||
multiple
|
||||
|
|
@ -138,7 +122,4 @@ console.
|
|||
|
||||
## Skeleton
|
||||
|
||||
Display a loading state using the `FileUploaderSkeleton` component. This provides
|
||||
visual feedback while the file uploader content is being loaded.
|
||||
|
||||
<FileUploaderSkeleton />
|
||||
|
|
@ -7,15 +7,9 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `FluidForm` component provides a fluid-width form layout that adapts to its
|
||||
container. It's designed for full-width form layouts and works with most Carbon
|
||||
input components. Note that inline input variants cannot be used within a
|
||||
`FluidForm`.
|
||||
|
||||
## Fluid form
|
||||
|
||||
Create a fluid-width form layout using the `FluidForm` component. This example
|
||||
shows a basic login form with required fields.
|
||||
Note that the `inline` input variants cannot be used within a `FluidForm`.
|
||||
|
||||
<FluidForm>
|
||||
<TextInput labelText="User name" placeholder="Enter user name..." required />
|
||||
|
|
@ -29,8 +23,4 @@ shows a basic login form with required fields.
|
|||
|
||||
## Invalid state
|
||||
|
||||
Handle form validation and display error states using the `invalid` and
|
||||
`invalidText` props on form inputs. This example demonstrates how to show
|
||||
validation errors in a fluid form.
|
||||
|
||||
<FileSource src="/framed/FluidForm/FluidFormInvalid" />
|
||||
|
|
@ -14,15 +14,8 @@ components: ["Form", "FormGroup"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `Form` component provides a structured way to collect user input. It works with
|
||||
various form controls like checkboxes, radio buttons, and select menus. The
|
||||
`FormGroup` component helps organize related form controls with a legend.
|
||||
|
||||
## Form
|
||||
|
||||
Create a form with grouped controls using `Form` and `FormGroup`. This example
|
||||
shows a form with checkboxes, radio buttons, and a select menu.
|
||||
|
||||
<Form on:submit>
|
||||
<FormGroup legendText="Checkboxes">
|
||||
<Checkbox id="checkbox-0" labelText="Checkbox Label" checked />
|
||||
|
|
@ -70,9 +63,7 @@ shows a form with checkboxes, radio buttons, and a select menu.
|
|||
|
||||
## Prevent default behavior
|
||||
|
||||
Handle form submission by preventing the default browser behavior. Use
|
||||
`e.preventDefault()` to stop the native form submission and handle the event
|
||||
programmatically.
|
||||
The forwarded `submit` event is not modified. Use `e.preventDefault()` to prevent the native form submission behavior.
|
||||
|
||||
<Form on:submit={e => {
|
||||
e.preventDefault();
|
||||
|
|
|
|||
|
|
@ -6,62 +6,34 @@ components: ["Grid", "Row", "Column"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `Grid` system provides a responsive, 12-column layout structure. Use `Row` and
|
||||
`Column` components to create flexible layouts that adapt to different screen
|
||||
sizes. The grid supports various spacing options and column configurations.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic grid layout with equal-width columns. This example demonstrates the
|
||||
default grid behavior.
|
||||
|
||||
<FileSource src="/framed/Grid/Grid" />
|
||||
|
||||
## Full width
|
||||
|
||||
Use the full-width grid variant for layouts that span the entire viewport width.
|
||||
This removes the default max-width constraint.
|
||||
|
||||
<FileSource src="/framed/Grid/FullWidthGrid" />
|
||||
|
||||
## Narrow
|
||||
|
||||
Create a more compact grid layout using the narrow variant. This reduces the
|
||||
spacing between columns.
|
||||
|
||||
<FileSource src="/framed/Grid/NarrowGrid" />
|
||||
|
||||
## Condensed
|
||||
|
||||
Use the condensed variant for even tighter spacing between columns. This is ideal
|
||||
for dense data displays.
|
||||
|
||||
<FileSource src="/framed/Grid/CondensedGrid" />
|
||||
|
||||
## Responsive
|
||||
|
||||
Build responsive layouts by specifying different column widths for different
|
||||
breakpoints. The grid automatically adjusts based on screen size.
|
||||
|
||||
<FileSource src="/framed/Grid/ResponsiveGrid" />
|
||||
|
||||
## Offset columns
|
||||
|
||||
Create space between columns using the offset feature. This allows for more
|
||||
flexible layouts without empty columns.
|
||||
|
||||
<FileSource src="/framed/Grid/OffsetColumns" />
|
||||
|
||||
## Aspect ratio columns
|
||||
|
||||
Maintain consistent column heights using aspect ratio columns. This ensures
|
||||
content alignment across different column widths.
|
||||
|
||||
<FileSource src="/framed/Grid/AspectRatioColumns" />
|
||||
|
||||
## Padded columns
|
||||
|
||||
Add padding to columns using the padded variant. This creates more breathing room
|
||||
between content.
|
||||
|
||||
<FileSource src="/framed/Grid/PaddedGrid" />
|
||||
|
|
|
|||
|
|
@ -5,22 +5,15 @@
|
|||
let key = 0;
|
||||
</script>
|
||||
|
||||
The `ImageLoader` component provides a robust way to load images with built-in
|
||||
loading and error states. It uses the [Image API](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/Image)
|
||||
to handle image loading programmatically. The component supports aspect ratios,
|
||||
fade-in animations, and custom loading/error states.
|
||||
This utility component uses the [Image API](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/Image) to programmatically load an image with slottable loading and error states.
|
||||
|
||||
## Default
|
||||
|
||||
Load an image with the default configuration. The component handles the loading
|
||||
process automatically.
|
||||
|
||||
<ImageLoader src="https://upload.wikimedia.org/wikipedia/commons/5/51/IBM_logo.svg" />
|
||||
|
||||
## Slots
|
||||
|
||||
Customize the loading and error states using named slots. This example shows how
|
||||
to display a loading indicator and error message.
|
||||
Use the "loading" and "error" named slots to render an element when the image is loading or has an error.
|
||||
|
||||
<ImageLoader src="https://upload.wikimedia.org/wikipedia/commons/5/51/IBM_logo.svg">
|
||||
<svelte:fragment slot="loading">
|
||||
|
|
@ -33,32 +26,21 @@ to display a loading indicator and error message.
|
|||
|
||||
## With aspect ratio
|
||||
|
||||
Maintain consistent image dimensions using aspect ratios. The component uses
|
||||
[AspectRatio](/components/AspectRatio) to constrain the image.
|
||||
If `ratio` is set, this component uses the [AspectRatio](/components/AspectRatio) to constrain the image.
|
||||
|
||||
Supported aspect ratios include `"2x1"`, `"2x3"`, `"16x9"`, `"4x3"`, `"1x1"`,
|
||||
`"3x4"`, `"3x2"`, `"9x16"` and `"1x2"`.
|
||||
Supported aspect ratios include `"2x1"`, `"2x3"`, `"16x9"`, `"4x3"`, `"1x1"`, `"3x4"`, `"3x2"`, `"9x16"` and `"1x2"`.
|
||||
|
||||
<ImageLoader ratio="16x9" src="https://upload.wikimedia.org/wikipedia/commons/5/51/IBM_logo.svg" />
|
||||
|
||||
## Fade in
|
||||
|
||||
Enable a smooth fade-in animation when the image loads successfully. This provides
|
||||
a better user experience for image loading.
|
||||
Set `fadeIn` to `true` to fade in the image if successfully loaded.
|
||||
|
||||
<Button kind="ghost" on:click="{() => { key++;}}">Reload image</Button>
|
||||
{#key key}<ImageLoader fadeIn ratio="16x9" src="https://upload.wikimedia.org/wikipedia/commons/5/51/IBM_logo.svg" />{/key}
|
||||
|
||||
## Programmatic usage
|
||||
|
||||
Control image loading programmatically using component references. This example
|
||||
demonstrates how to trigger image loading manually.
|
||||
In this example, a component reference is obtained to programmatically trigger the `loadImage` method.
|
||||
|
||||
<FileSource src="/framed/ImageLoader/ProgrammaticImageLoader" />
|
||||
|
||||
## Dynamic image source
|
||||
|
||||
Update the image source dynamically using the same `ImageLoader` instance. This
|
||||
allows for smooth transitions between different images.
|
||||
|
||||
<FileSource src="/framed/ImageLoader/DynamicImageLoader" />
|
||||
|
|
|
|||
|
|
@ -1,37 +1,18 @@
|
|||
---
|
||||
components: ["InlineLoading"]
|
||||
---
|
||||
|
||||
<script>
|
||||
import { InlineLoading, UnorderedList, ListItem } from "carbon-components-svelte";
|
||||
import { InlineLoading } from "carbon-components-svelte";
|
||||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `InlineLoading` component provides a compact loading indicator that can be embedded within content. It's ideal for showing progress during inline operations like form submissions or data updates.
|
||||
|
||||
## Default
|
||||
|
||||
Display a basic loading indicator with the default configuration.
|
||||
|
||||
<InlineLoading />
|
||||
|
||||
## With description
|
||||
|
||||
Add a descriptive text to provide context about the loading operation.
|
||||
|
||||
<InlineLoading description="Loading metrics..." />
|
||||
|
||||
## Status states
|
||||
|
||||
The component supports different status states to indicate progress:
|
||||
|
||||
<UnorderedList svx-ignore style="margin-bottom: var(--cds-spacing-08)">
|
||||
<ListItem><strong>active</strong>: Shows an animated loading indicator</ListItem>
|
||||
<ListItem><strong>inactive</strong>: Displays a static state</ListItem>
|
||||
<ListItem><strong>finished</strong>: Shows a success state</ListItem>
|
||||
<ListItem><strong>error</strong>: Displays an error state</ListItem>
|
||||
</UnorderedList>
|
||||
|
||||
<InlineLoading status="active" description="Submitting..." />
|
||||
<InlineLoading status="inactive" description="Cancelling..." />
|
||||
<InlineLoading status="finished" description="Success" />
|
||||
|
|
@ -39,6 +20,4 @@ The component supports different status states to indicate progress:
|
|||
|
||||
## UX example
|
||||
|
||||
See how to integrate the loading indicator in a real-world scenario.
|
||||
|
||||
<FileSource src="/framed/InlineLoading/InlineLoadingUx" />
|
||||
|
|
@ -7,29 +7,26 @@ components: ["InlineNotification", "NotificationActionButton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `InlineNotification` component displays contextual messages inline with content. It supports various types of notifications (error, warning, success, info) and can include actions. Use it to provide feedback or important information to users.
|
||||
Notification that appears inline.
|
||||
|
||||
See [detailed usage](https://carbondesignsystem.com/components/notification/usage).
|
||||
See [detailed
|
||||
usage](https://carbondesignsystem.com/components/notification/usage).
|
||||
See also: [ToastNotification](ToastNotification)
|
||||
|
||||
## Default
|
||||
|
||||
Display a basic error notification with title and subtitle by default.
|
||||
## Default (error)
|
||||
|
||||
<InlineNotification title="Error:" subtitle="An internal server error occurred." />
|
||||
|
||||
## Prevent default close behavior
|
||||
|
||||
The component is controlled, allowing you to prevent the default close behavior using `e.preventDefault()`.
|
||||
`InlineNotification` is a controlled component. Prevent the default close behavior using the `e.preventDefault()` method in the dispatched `on:close` event.
|
||||
|
||||
<InlineNotification title="Error" subtitle="An internal server error occurred." on:close={(e) => {
|
||||
e.preventDefault();
|
||||
// custom close logic (e.g., transitions)
|
||||
}} />
|
||||
|
||||
## Slottable title and subtitle
|
||||
|
||||
Customize the notification content using slots for more flexibility.
|
||||
## Slottable title, subtitle
|
||||
|
||||
<InlineNotification>
|
||||
<strong slot="title">Error: </strong>
|
||||
|
|
@ -38,7 +35,9 @@ Customize the notification content using slots for more flexibility.
|
|||
|
||||
## Accessible icon descriptions
|
||||
|
||||
Make notifications more accessible by providing custom descriptions for icons.
|
||||
The status icon and close button icon descriptions appear on cursor hover and are read
|
||||
by assistive technology. Default descriptions are provided in English and can be
|
||||
overridden via `statusIconDescription` and `closeButtonDescription`.
|
||||
|
||||
<InlineNotification
|
||||
title="错误"
|
||||
|
|
@ -49,14 +48,10 @@ Make notifications more accessible by providing custom descriptions for icons.
|
|||
|
||||
## Hidden close button
|
||||
|
||||
Create a persistent notification by hiding the close button.
|
||||
|
||||
<InlineNotification hideCloseButton kind="warning" title="Scheduled maintenance:" subtitle="Maintenance will last 2-4 hours." />
|
||||
|
||||
## With actions
|
||||
|
||||
Add interactive elements to notifications using the actions slot.
|
||||
|
||||
<InlineNotification kind="warning" title="Scheduled maintenance:" subtitle="Maintenance will last 2-4 hours.">
|
||||
<svelte:fragment slot="actions">
|
||||
<NotificationActionButton>Learn more</NotificationActionButton>
|
||||
|
|
@ -65,8 +60,6 @@ Add interactive elements to notifications using the actions slot.
|
|||
|
||||
## Notification variants
|
||||
|
||||
The component supports different notification types:
|
||||
|
||||
<InlineNotification kind="error" title="Error:" subtitle="An internal server error occurred." />
|
||||
<InlineNotification kind="info" title="New updates:" subtitle="Restart to get the latest updates." />
|
||||
<InlineNotification kind="info-square" title="New updates:" subtitle="Restart to get the latest updates." />
|
||||
|
|
@ -76,8 +69,6 @@ The component supports different notification types:
|
|||
|
||||
## Low contrast
|
||||
|
||||
Use low contrast variants for less prominent notifications.
|
||||
|
||||
<InlineNotification lowContrast kind="error" title="Error:" subtitle="An internal server error occurred." />
|
||||
<InlineNotification lowContrast kind="info" title="New updates:" subtitle="Restart to get the latest updates." />
|
||||
<InlineNotification lowContrast kind="info-square" title="New updates:" subtitle="Restart to get the latest updates." />
|
||||
|
|
|
|||
|
|
@ -8,19 +8,17 @@ components: ["Link", "OutboundLink"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `Link` component provides styled hyperlinks with various customization options. It supports different sizes, states, and can include icons. The `OutboundLink` variant automatically handles external links with proper security attributes.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic link with the default styling.
|
||||
|
||||
<Link href="https://www.carbondesignsystem.com/">
|
||||
Carbon Design System
|
||||
</Link>
|
||||
|
||||
## Target _blank
|
||||
|
||||
For external links, the component automatically adds security attributes. You can override the `rel` attribute if needed.
|
||||
If setting `target` to `"_blank"`, the `Link` component will automatically set `rel="noopener noreferrer"` to guard against [potential cross-origin security exploits](https://web.dev/external-anchors-use-rel-noopener/).
|
||||
|
||||
You can override the `rel` attribute with a custom value.
|
||||
|
||||
<Link href="https://www.carbondesignsystem.com/" target="_blank">
|
||||
Carbon Design System
|
||||
|
|
@ -28,7 +26,7 @@ For external links, the component automatically adds security attributes. You ca
|
|||
|
||||
## Outbound link
|
||||
|
||||
Use `OutboundLink` as a convenient alternative for external links.
|
||||
An alternative to manually setting `target` to `"_blank"` is to use the `OutboundLink`.
|
||||
|
||||
<OutboundLink href="https://www.carbondesignsystem.com/">
|
||||
Carbon Design System
|
||||
|
|
@ -36,8 +34,6 @@ Use `OutboundLink` as a convenient alternative for external links.
|
|||
|
||||
## Inline variant
|
||||
|
||||
Create links that flow naturally with surrounding text.
|
||||
|
||||
<div>
|
||||
Visit the
|
||||
<Link inline href="https://www.carbondesignsystem.com/">
|
||||
|
|
@ -47,7 +43,7 @@ Create links that flow naturally with surrounding text.
|
|||
|
||||
## Link with icon
|
||||
|
||||
Add icons to links for better visual context. Note that `inline` must be `false` when using icons.
|
||||
Note that `inline` must be `false` when rendering a link with an icon.
|
||||
|
||||
<div>
|
||||
Visit the
|
||||
|
|
@ -56,34 +52,28 @@ Add icons to links for better visual context. Note that `inline` must be `false`
|
|||
</Link>.
|
||||
</div>
|
||||
|
||||
## Size variants
|
||||
|
||||
The component supports different sizes to match your design needs:
|
||||
## Large size
|
||||
|
||||
<Link size="lg" href="https://www.carbondesignsystem.com/">
|
||||
Large link
|
||||
Carbon Design System
|
||||
</Link>
|
||||
<br />
|
||||
<Link href="https://www.carbondesignsystem.com/">
|
||||
Default link
|
||||
</Link>
|
||||
<br />
|
||||
|
||||
## Small size
|
||||
|
||||
<Link size="sm" href="https://www.carbondesignsystem.com/">
|
||||
Small link
|
||||
Carbon Design System
|
||||
</Link>
|
||||
|
||||
## Disabled state
|
||||
## Disabled
|
||||
|
||||
Disabled links render as plain text while maintaining accessibility.
|
||||
A `disabled` link will render a `p` tag instead of an anchor element.
|
||||
|
||||
<Link disabled href="https://www.carbondesignsystem.com/">
|
||||
Disabled link
|
||||
Carbon Design System
|
||||
</Link>
|
||||
|
||||
## Visited styles
|
||||
|
||||
Show visited state styling for links.
|
||||
|
||||
<Link visited href="https://www.carbondesignsystem.com/">
|
||||
Visited link
|
||||
Carbon Design System
|
||||
</Link>
|
||||
|
|
@ -1,28 +1,16 @@
|
|||
---
|
||||
components: ["Loading"]
|
||||
---
|
||||
|
||||
<script>
|
||||
import { Loading } from "carbon-components-svelte";
|
||||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `Loading` component provides a full-screen or inline loading indicator. It's ideal for showing progress during page loads or data fetching operations.
|
||||
|
||||
## Default
|
||||
|
||||
Display a loading indicator with a semi-transparent overlay that covers the entire viewport.
|
||||
## Default (with overlay)
|
||||
|
||||
<FileSource src="/framed/Loading/Loading" />
|
||||
|
||||
## No overlay
|
||||
|
||||
Show a loading indicator without the overlay, allowing interaction with the underlying content.
|
||||
|
||||
<Loading withOverlay={false} />
|
||||
|
||||
## Small size
|
||||
|
||||
Display a more compact loading indicator.
|
||||
|
||||
<Loading withOverlay={false} small />
|
||||
|
|
@ -1,26 +1,23 @@
|
|||
---
|
||||
components: ["LocalStorage"]
|
||||
---
|
||||
|
||||
<script>
|
||||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `LocalStorage` component provides a reactive wrapper around the [Window.localStorage API](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). It's useful for persisting user preferences and application state across page reloads.
|
||||
This utility component wraps the [Window.localStorage API](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) and is useful for persisting ephemeral data (e.g., color theme) at the browser level.
|
||||
|
||||
## Reactive example
|
||||
|
||||
See how the component maintains state across page reloads. Toggle the switch and refresh the page to see the persisted state.
|
||||
In the example below, toggle the switch and reload the page. The updated theme should be persisted locally.
|
||||
|
||||
<FileSource src="/framed/LocalStorage/LocalStorage" />
|
||||
|
||||
## Clear item, clear all
|
||||
|
||||
The component provides methods to manage stored data:
|
||||
Use the `bind:this` directive to access the `clearItem` and `clearAll` methods.
|
||||
|
||||
- `clearItem`: Remove a specific key-value pair
|
||||
- `clearAll`: Remove all stored data
|
||||
Invoking `clearItem` will remove the persisted key value from the browser's local storage.
|
||||
|
||||
Use `bind:this` to access these methods. In this example, try toggling the switch, refreshing the page, then clearing the storage.
|
||||
Invoking `clearAll` will remove all key values.
|
||||
|
||||
In the following example, toggle the switch and reload the page. Then, click the "Clear storage" button. Refresh the page; the theme should be reset to the untoggled state.
|
||||
|
||||
<FileSource src="/framed/LocalStorage/LocalStorageClear" />
|
||||
|
|
@ -2,78 +2,60 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `Modal` component provides a focused dialog for user interactions, confirmations, or data entry. It supports various sizes, states, and customization options to create accessible and user-friendly modal experiences.
|
||||
|
||||
## Default
|
||||
|
||||
Display a modal dialog with a header, content area, and footer by default.
|
||||
|
||||
Create a basic modal dialog with primary and secondary actions. This variant is ideal for confirming user actions or gathering input.
|
||||
## Default (transactional)
|
||||
|
||||
<FileSource src="/framed/Modal/Modal" />
|
||||
|
||||
## Custom focus
|
||||
|
||||
Control which element receives focus when the modal opens. Use `selectorPrimaryFocus` to specify the target element using CSS selectors.
|
||||
By default, the modal close button will be focused when opened.
|
||||
|
||||
Use the `selectorPrimaryFocus` to specify the element that should be focused when the modal is opened (e.g., `#id`, `.class`, `[data-attribute]`).
|
||||
|
||||
<FileSource src="/framed/Modal/ModalCustomFocus" />
|
||||
|
||||
## Danger modal
|
||||
|
||||
Display critical actions or destructive operations with the danger variant. This style emphasizes the severity of the action.
|
||||
|
||||
<FileSource src="/framed/Modal/DangerModal" />
|
||||
|
||||
## Passive modal
|
||||
|
||||
Create a non-interactive modal for displaying information. This variant lacks action buttons and focuses on content presentation.
|
||||
|
||||
<FileSource src="/framed/Modal/PassiveModal" />
|
||||
|
||||
## Has scrolling content
|
||||
|
||||
Enable vertical scrolling for modals with lengthy content. This ensures all content remains accessible while maintaining a reasonable modal height.
|
||||
Setting `hasScrollingContent` to `true` increases the vertical space within the modal.
|
||||
|
||||
<FileSource src="/framed/Modal/ModalScrollingContent" />
|
||||
|
||||
## Multiple modals
|
||||
|
||||
Stack multiple modals for complex workflows. Each modal maintains its own state and focus management.
|
||||
|
||||
<FileSource src="/framed/Modal/ModalMultiple" />
|
||||
|
||||
## Multiple secondary buttons
|
||||
|
||||
Add up to two secondary actions using the `secondaryButtons` prop. This provides more flexibility than the single `secondaryButtonText` option.
|
||||
Use the `secondaryButtons` prop to render two secondary buttons. The prop is a 2-tuple type that supersedes `secondaryButtonText`.
|
||||
|
||||
<FileSource src="/framed/Modal/3ButtonModal" />
|
||||
|
||||
## Extra-small size
|
||||
|
||||
Use the extra-small size for compact notifications by setting `size` to `"xs"`. This is ideal for simple confirmations.
|
||||
|
||||
<FileSource src="/framed/Modal/ModalExtraSmall" />
|
||||
|
||||
## Small size
|
||||
|
||||
Use the small size for simple confirmations by setting `size` to `"sm"`. This provides a more focused dialog.
|
||||
|
||||
<FileSource src="/framed/Modal/ModalSmall" />
|
||||
|
||||
## Large size
|
||||
|
||||
Use the large size for complex content by setting `size` to `"lg"`. This provides more space for detailed information.
|
||||
|
||||
<FileSource src="/framed/Modal/ModalLarge" />
|
||||
|
||||
## Prevent close on outside click
|
||||
|
||||
Disable closing the modal when clicking outside by setting `preventCloseOnClickOutside` to `true`. This is useful for transactional modals where explicit user action is required.
|
||||
`preventCloseOnClickOutside` prevents the modal from being closed when clicking outside of an open modal. This prop is intended to be used for transactional modals.
|
||||
|
||||
<FileSource src="/framed/Modal/ModalPreventOutsideClick" />
|
||||
|
||||
## Button with icon
|
||||
|
||||
Enhance modal buttons with icons for better visual context and clarity. This example shows how to add icons to modal actions.
|
||||
|
||||
<FileSource src="/framed/Modal/ModalButtonWithIcon" />
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `MultiSelect` component provides a dropdown interface for selecting multiple options using checkboxes. It supports filtering, custom formatting, and various states. Each item must have a unique `id` property for proper functionality.
|
||||
`MultiSelect` is keyed for performance reasons.
|
||||
|
||||
<InlineNotification svx-ignore lowContrast title="Note:" kind="info" hideCloseButton>
|
||||
<div class="body-short-01">Every <code>items</code> object must have a unique "id" property.</div>
|
||||
|
|
@ -11,7 +11,12 @@ The `MultiSelect` component provides a dropdown interface for selecting multiple
|
|||
|
||||
## Default
|
||||
|
||||
Create a basic multi-select dropdown with three contact methods. By default, items are ordered alphabetically.
|
||||
By default, items will be ordered alphabetically based on the `item.text` value.
|
||||
To prevent this, see [#no-alphabetical-ordering](#no-alphabetical-ordering).
|
||||
|
||||
MultiSelect provides interactivity for a list of checkbox inputs. Those
|
||||
checkboxes will remain rendered in the DOM and are submittable within forms.
|
||||
Checkbox attributes can be adjusted via the `itemToInput` prop.
|
||||
|
||||
<MultiSelect titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
|
|
@ -19,28 +24,15 @@ Create a basic multi-select dropdown with three contact methods. By default, ite
|
|||
{id: "2", text: "Fax"}]}"
|
||||
/>
|
||||
|
||||
## Format item display text
|
||||
|
||||
Format the display text of items using the `itemToString` prop. This example appends the item ID in parentheses.
|
||||
|
||||
<MultiSelect itemToString={item => {
|
||||
return item.text + ' (' + item.id +')'
|
||||
}} titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}"
|
||||
sortItem="{() => {}}"
|
||||
/>
|
||||
|
||||
## Custom slot
|
||||
|
||||
Override the default slot to customize item rendering. This example shows how to access and use the item and index values.
|
||||
Override the default slot to customize the display of each item. Access the item and index through the `let:` directive.
|
||||
|
||||
<FileSource src="/framed/MultiSelect/MultiSelectSlot" />
|
||||
|
||||
## No alphabetical ordering
|
||||
|
||||
Prevent automatic alphabetical ordering by passing a no-op function to `sortItem`. This maintains the original order of items.
|
||||
To prevent alphabetical item ordering, pass an empty function to the `sortItem` prop.
|
||||
|
||||
<MultiSelect titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
|
|
@ -51,7 +43,7 @@ Prevent automatic alphabetical ordering by passing a no-op function to `sortItem
|
|||
|
||||
## Filterable
|
||||
|
||||
Enable filtering by setting `filterable` to `true`. This example includes a placeholder text for the filter input.
|
||||
`$$restProps` are spread to the underlying input element.
|
||||
|
||||
<MultiSelect spellcheck="false" filterable titleText="Contact" placeholder="Filter contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
|
|
@ -61,7 +53,7 @@ Enable filtering by setting `filterable` to `true`. This example includes a plac
|
|||
|
||||
## Initial selected items
|
||||
|
||||
Pre-select items by passing an array of item IDs to `selectedIds`. This example pre-selects Slack and Email.
|
||||
To select (or bind) items, pass an array of item ids to `selectedIds`.
|
||||
|
||||
<MultiSelect selectedIds="{["0", "1"]}" titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
|
|
@ -71,24 +63,32 @@ Pre-select items by passing an array of item IDs to `selectedIds`. This example
|
|||
|
||||
## Multiple multi-select dropdowns
|
||||
|
||||
This example demonstrates how to manage multiple dropdowns in a form with coordinated state.
|
||||
|
||||
<FileSource src="/framed/MultiSelect/MultipleMultiSelect" />
|
||||
|
||||
## Format checkbox values
|
||||
## Format item display text
|
||||
|
||||
Customize checkbox attributes using the `itemToInput` prop. This example sets a consistent name for all checkboxes.
|
||||
Use the `itemToString` prop to format the display of individual items.
|
||||
|
||||
<MultiSelect itemToString={item => {
|
||||
return item.text + ' (' + item.id +')'
|
||||
}} titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}"
|
||||
sortItem="{() => {}}"
|
||||
/>
|
||||
|
||||
## Format checkbox values
|
||||
|
||||
Use the `itemToInput` prop to customize the user-selectable checkbox values.
|
||||
This will also override the underlying hidden inputs used for form submission.
|
||||
|
||||
For example:
|
||||
|
||||
```js
|
||||
itemToInput={(item) => {
|
||||
return {
|
||||
name: `Contact_${item.id}`,
|
||||
value: item.id
|
||||
}
|
||||
}}
|
||||
(item) => ({name: `Contact_${item.id}`], value: item.id})
|
||||
|
||||
|
||||
```
|
||||
|
||||
The above function sets the `name` attribute to
|
||||
|
|
@ -108,7 +108,7 @@ renders, along with each respective item's `id` set to the `value` attribute.
|
|||
|
||||
## Top direction
|
||||
|
||||
Display the dropdown menu above the input by setting `direction` to `"top"`. This is useful when space below is limited.
|
||||
Set `direction` to `"top"` for the dropdown menu to appear above the input.
|
||||
|
||||
<MultiSelect direction="top" titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
|
|
@ -118,8 +118,6 @@ Display the dropdown menu above the input by setting `direction` to `"top"`. Thi
|
|||
|
||||
## Hidden label
|
||||
|
||||
Hide the label visually while maintaining accessibility by setting `hideLabel` to `true`. The label is still available to screen readers.
|
||||
|
||||
<MultiSelect titleText="Contact" label="Select contact methods..." hideLabel
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
|
|
@ -128,8 +126,6 @@ Hide the label visually while maintaining accessibility by setting `hideLabel` t
|
|||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for dark backgrounds by setting `light` to `true`. This provides better contrast in dark themes.
|
||||
|
||||
<MultiSelect light titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
|
|
@ -138,19 +134,15 @@ Use the light variant for dark backgrounds by setting `light` to `true`. This pr
|
|||
|
||||
## Inline variant
|
||||
|
||||
Display the dropdown inline with other content by setting `type` to `"inline"`. This removes the background and border.
|
||||
|
||||
<MultiSelect type="inline" titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}"
|
||||
/>
|
||||
|
||||
## Extra-large size
|
||||
## Large size
|
||||
|
||||
Use the extra-large size for prominent selections by setting `size` to `"xl"`. This provides more visual emphasis.
|
||||
|
||||
<MultiSelect size="xl" titleText="Contact" label="Select contact methods..."
|
||||
<MultiSelect size="lg" titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
{id: "2", text: "Fax"}]}"
|
||||
|
|
@ -158,8 +150,6 @@ Use the extra-large size for prominent selections by setting `size` to `"xl"`. T
|
|||
|
||||
## Small size
|
||||
|
||||
Use the small size for compact layouts by setting `size` to `"sm"`. This is ideal for secondary selections.
|
||||
|
||||
<MultiSelect size="sm" titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
|
|
@ -168,8 +158,6 @@ Use the small size for compact layouts by setting `size` to `"sm"`. This is idea
|
|||
|
||||
## Invalid state
|
||||
|
||||
Indicate an invalid selection by setting `invalid` to `true`. This example shows a required field error.
|
||||
|
||||
<MultiSelect invalid invalidText="A contact method is required" titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
|
|
@ -178,8 +166,6 @@ Indicate an invalid selection by setting `invalid` to `true`. This example shows
|
|||
|
||||
## Warning state
|
||||
|
||||
Indicate a warning state by setting `warn` to `true`. This example shows a warning about unassociated accounts.
|
||||
|
||||
<MultiSelect warn warnText="One or more contact methods are not associated with your account" titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
|
|
@ -188,8 +174,6 @@ Indicate a warning state by setting `warn` to `true`. This example shows a warni
|
|||
|
||||
## Disabled state
|
||||
|
||||
Disable the entire dropdown by setting `disabled` to `true`. This prevents all user interaction.
|
||||
|
||||
<MultiSelect disabled titleText="Contact" label="Select contact methods..."
|
||||
items="{[{id: "0", text: "Slack"},
|
||||
{id: "1", text: "Email"},
|
||||
|
|
@ -198,7 +182,7 @@ Disable the entire dropdown by setting `disabled` to `true`. This prevents all u
|
|||
|
||||
## Disabled items
|
||||
|
||||
Disable specific items using the `disabled` property in the `items` prop. This example disables the Email option.
|
||||
Use the `disabled` property in the `items` prop to disable specific items.
|
||||
|
||||
<MultiSelect
|
||||
titleText="Contact"
|
||||
|
|
|
|||
|
|
@ -7,100 +7,74 @@ components: ["NumberInput", "NumberInputSkeleton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
The `NumberInput` component provides a controlled input for numerical values. It supports validation, step values, and various states to ensure accurate data entry.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic number input with increment and decrement controls. The input accepts numerical values and provides visual feedback.
|
||||
This component requires a numerical value for `value`.
|
||||
|
||||
See [#no-value](#no-value) to allow for an empty value.
|
||||
|
||||
<NumberInput label="Clusters" value={0} />
|
||||
|
||||
## No value
|
||||
|
||||
Allow empty values by setting both `allowEmpty` to `true` and `value` to `null`. The `allowEmpty` prop enables the empty state, while `value={null}` represents no value.
|
||||
|
||||
<FileSource src="/framed/NumberInput/NumberInputEmpty" />
|
||||
|
||||
## Helper text
|
||||
|
||||
Add descriptive text below the input using the `helperText` prop. This helps users understand the expected input.
|
||||
## With helper text
|
||||
|
||||
<NumberInput label="Clusters" value={0} helperText="Clusters provisioned in your region" />
|
||||
|
||||
## Minimum and maximum values
|
||||
|
||||
Constrain input values using `min` and `max` props. This example limits values between 4 and 20.
|
||||
|
||||
<NumberInput min="{4}" max="{20}" value="{4}" invalidText="Number must be between 4 and 20." helperText="Clusters provisioned in your region" label="Clusters (4 min, 20 max)" />
|
||||
|
||||
## Step value
|
||||
|
||||
Control the increment/decrement step size using the `step` prop. This example uses a step of 0.1.
|
||||
## With step value
|
||||
|
||||
<NumberInput value="{1}" helperText="Step of 0.1" step={0.1} label="Clusters" />
|
||||
|
||||
## Hidden label
|
||||
## No value
|
||||
|
||||
Hide the label visually while maintaining accessibility by setting `hideLabel` to `true`. The label is still available to screen readers.
|
||||
Set `allowEmpty` to `true` to allow for no value.
|
||||
|
||||
Set `value` to `null` to denote "no value."
|
||||
|
||||
<FileSource src="/framed/NumberInput/NumberInputEmpty" />
|
||||
|
||||
## Hidden label
|
||||
|
||||
<NumberInput hideLabel label="Clusters" value={0} />
|
||||
|
||||
## Extra-large size
|
||||
## Hidden steppers
|
||||
|
||||
Use the extra-large size for prominent inputs by setting `size` to `"xl"`. This provides more visual emphasis.
|
||||
|
||||
<NumberInput size="xl" label="Clusters" value={0} />
|
||||
|
||||
## Small size
|
||||
|
||||
Use the small size for compact layouts by setting `size` to `"sm"`. This is ideal for secondary inputs.
|
||||
|
||||
<NumberInput size="sm" label="Clusters" value={0} />
|
||||
<NumberInput hideSteppers label="Clusters" value={0} />
|
||||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for dark backgrounds by setting `light` to `true`. This provides better contrast in dark themes.
|
||||
|
||||
<NumberInput light label="Clusters" value={0} />
|
||||
|
||||
## Invalid state
|
||||
## Read-only variant
|
||||
|
||||
Indicate an invalid value by setting `invalid` to `true`. This example shows a validation error.
|
||||
<NumberInput readonly label="Clusters" value={0} />
|
||||
|
||||
## Large size
|
||||
|
||||
<NumberInput size="lg" label="Clusters" value={0} />
|
||||
|
||||
## Small size
|
||||
|
||||
<NumberInput size="sm" label="Clusters" value={0} />
|
||||
|
||||
## Invalid state
|
||||
|
||||
<NumberInput invalid invalidText="Invalid value" label="Clusters" value={0} />
|
||||
|
||||
## Warning state
|
||||
|
||||
Indicate a warning state by setting `warn` to `true`. This example shows a warning about the input value.
|
||||
|
||||
<NumberInput warn warnText="A high number may impact initial rollout" label="Clusters" value={25} />
|
||||
|
||||
## Disabled state
|
||||
|
||||
Disable the input by setting `disabled` to `true`. This prevents all user interaction.
|
||||
|
||||
<NumberInput disabled label="Clusters" value={0} />
|
||||
|
||||
## Read-only state
|
||||
|
||||
Make the input read-only by setting `readonly` to `true`. This allows viewing but prevents editing.
|
||||
|
||||
<NumberInput readonly label="Clusters" value={0} />
|
||||
|
||||
## Hidden steppers
|
||||
|
||||
Hide the increment/decrement controls by setting `hideSteppers` to `true`. This provides a simpler input interface.
|
||||
|
||||
<NumberInput hideSteppers label="Clusters" value={0} />
|
||||
|
||||
## Skeleton
|
||||
|
||||
Show a loading state using the `NumberInputSkeleton` component. This is useful while data is being fetched.
|
||||
|
||||
<NumberInputSkeleton />
|
||||
|
||||
## Skeleton without label
|
||||
|
||||
Show a loading state without a label by setting `hideLabel` to `true`. This maintains layout consistency.
|
||||
|
||||
<NumberInputSkeleton hideLabel />
|
||||
|
|
@ -7,18 +7,14 @@ components: ["OrderedList", "ListItem"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`OrderedList` provides a structured way to display numbered lists of items. It supports nested lists, native browser styles, and expressive typography for enhanced visual hierarchy.
|
||||
|
||||
<InlineNotification svx-ignore lowContrast title="Tip:" kind="info" hideCloseButton>
|
||||
<div class="body-short-01">
|
||||
Consider using the <Link href="/components/RecursiveList#ordered">RecursiveList</Link> component for rendering tree structured data.
|
||||
</div>
|
||||
</div>
|
||||
</InlineNotification>
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic ordered list by wrapping `ListItem` components within `OrderedList`.
|
||||
|
||||
<OrderedList>
|
||||
<ListItem>Ordered list item</ListItem>
|
||||
<ListItem>Ordered list item</ListItem>
|
||||
|
|
@ -27,8 +23,6 @@ Create a basic ordered list by wrapping `ListItem` components within `OrderedLis
|
|||
|
||||
## With links
|
||||
|
||||
Add interactive elements like `Link` components within list items.
|
||||
|
||||
<OrderedList>
|
||||
<ListItem>
|
||||
<Link href="#">Ordered list item</Link>
|
||||
|
|
@ -43,8 +37,6 @@ Add interactive elements like `Link` components within list items.
|
|||
|
||||
## Nested
|
||||
|
||||
Set the `nested` prop to `true` to create hierarchical lists with proper indentation and numbering.
|
||||
|
||||
<OrderedList>
|
||||
<ListItem>
|
||||
Ordered list level 1
|
||||
|
|
@ -65,7 +57,7 @@ Set the `nested` prop to `true` to create hierarchical lists with proper indenta
|
|||
|
||||
## Native list styles
|
||||
|
||||
Enable native browser list styles by setting the `native` prop to `true`. This is useful for large lists where the list number may overlap with the list item text.
|
||||
Use the `native` attribute to enable default browser list styles. This is useful for large lists (i.e., 1000 or more items) where the list number may overlap with the list item text.
|
||||
|
||||
<OrderedList native>
|
||||
<ListItem>
|
||||
|
|
@ -87,7 +79,7 @@ Enable native browser list styles by setting the `native` prop to `true`. This i
|
|||
|
||||
## Expressive styles
|
||||
|
||||
Use Carbon's expressive typesetting by setting the `expressive` prop to `true`.
|
||||
Set `expressive` to `true` to use Carbon's expressive typesetting.
|
||||
|
||||
<OrderedList expressive>
|
||||
<ListItem><Link size="lg" href="#">Ordered list item</Link></ListItem>
|
||||
|
|
|
|||
|
|
@ -8,12 +8,8 @@ components: ["OverflowMenu", "OverflowMenuItem"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`OverflowMenu` provides a compact way to display a list of actions or options. It renders as a button that opens a dropdown menu when clicked, making it ideal for secondary actions or overflow content.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic overflow menu by wrapping `OverflowMenuItem` components within `OverflowMenu`.
|
||||
|
||||
<OverflowMenu>
|
||||
<OverflowMenuItem text="Manage credentials" />
|
||||
<OverflowMenuItem href="https://cloud.ibm.com/docs/api-gateway/" text="API documentation" />
|
||||
|
|
@ -22,7 +18,7 @@ Create a basic overflow menu by wrapping `OverflowMenuItem` components within `O
|
|||
|
||||
## Flipped
|
||||
|
||||
Set `flipped` to `true` to position the menu to the left of the button.
|
||||
Set `flipped` to `true` for the menu to be positioned to the left of the button.
|
||||
|
||||
<OverflowMenu flipped>
|
||||
<OverflowMenuItem text="Manage credentials" />
|
||||
|
|
@ -30,9 +26,7 @@ Set `flipped` to `true` to position the menu to the left of the button.
|
|||
<OverflowMenuItem danger text="Delete service" />
|
||||
</OverflowMenu>
|
||||
|
||||
## Menu direction
|
||||
|
||||
Set `direction` to `"top"` to position the menu above the button.
|
||||
## Menu direction top
|
||||
|
||||
<OverflowMenu flipped direction="top">
|
||||
<OverflowMenuItem text="Manage credentials" />
|
||||
|
|
@ -42,17 +36,13 @@ Set `direction` to `"top"` to position the menu above the button.
|
|||
|
||||
## Light variant
|
||||
|
||||
Enable the light variant by setting `light` to `true`.
|
||||
|
||||
<OverflowMenu light>
|
||||
<OverflowMenuItem text="Manage credentials" />
|
||||
<OverflowMenuItem href="https://cloud.ibm.com/docs/api-gateway/" text="API documentation" />
|
||||
<OverflowMenuItem danger text="Delete service" />
|
||||
</OverflowMenu>
|
||||
|
||||
## Extra-large size
|
||||
|
||||
Set `size` to `"xl"` for an extra-large overflow menu.
|
||||
## Large size
|
||||
|
||||
<OverflowMenu size="xl">
|
||||
<OverflowMenuItem text="Manage credentials" />
|
||||
|
|
@ -62,8 +52,6 @@ Set `size` to `"xl"` for an extra-large overflow menu.
|
|||
|
||||
## Small size
|
||||
|
||||
Set `size` to `"sm"` for a small overflow menu.
|
||||
|
||||
<OverflowMenu size="sm">
|
||||
<OverflowMenuItem text="Manage credentials" />
|
||||
<OverflowMenuItem href="https://cloud.ibm.com/docs/api-gateway/" text="API documentation" />
|
||||
|
|
@ -72,7 +60,7 @@ Set `size` to `"sm"` for a small overflow menu.
|
|||
|
||||
## Custom primary focus
|
||||
|
||||
Set `primaryFocus` to `true` on a menu item to focus it when opening the dropdown.
|
||||
By default, the first overflow menu item is focused when opening the dropdown.
|
||||
|
||||
<OverflowMenu>
|
||||
<OverflowMenuItem text="Manage credentials" />
|
||||
|
|
@ -82,8 +70,6 @@ Set `primaryFocus` to `true` on a menu item to focus it when opening the dropdow
|
|||
|
||||
## Custom trigger icon
|
||||
|
||||
Replace the default vertical overflow menu icon with a custom icon.
|
||||
|
||||
<OverflowMenu icon={Add}>
|
||||
<OverflowMenuItem text="Manage credentials" />
|
||||
<OverflowMenuItem href="https://cloud.ibm.com/docs/api-gateway/" text="API documentation" />
|
||||
|
|
@ -92,8 +78,6 @@ Replace the default vertical overflow menu icon with a custom icon.
|
|||
|
||||
## Custom trigger slot
|
||||
|
||||
Use the `menu` slot to customize the trigger button content.
|
||||
|
||||
<OverflowMenu style="width: auto;">
|
||||
<div slot="menu" style="padding: 1rem; color: red;">Custom trigger</div>
|
||||
<OverflowMenuItem text="Manage credentials" />
|
||||
|
|
@ -103,7 +87,7 @@ Use the `menu` slot to customize the trigger button content.
|
|||
|
||||
## Disabled items
|
||||
|
||||
Set `disabled` to `true` to disable menu items. Use `hasDivider` to add visual separation between items.
|
||||
Disable menu items by setting `disabled` to `true`.
|
||||
|
||||
<OverflowMenu>
|
||||
<OverflowMenuItem text="Create key" />
|
||||
|
|
|
|||
|
|
@ -7,52 +7,26 @@ components: ["Pagination", "PaginationSkeleton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`Pagination` provides navigation controls for large data sets. It displays the current page, total items, and allows users to change page size and navigate between pages.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic pagination component with default page size options.
|
||||
|
||||
<Pagination totalItems={102} pageSizes={[10, 15, 20]} />
|
||||
<Pagination totalItems={102} pageSizes="{[10, 15, 20]}" />
|
||||
|
||||
## Current page
|
||||
|
||||
Set the current page using the `page` prop.
|
||||
|
||||
<Pagination totalItems={102} page={4} />
|
||||
|
||||
## Custom page sizes
|
||||
|
||||
Specify custom page sizes and set a default page size.
|
||||
|
||||
<Pagination totalItems={102} pageSizes={[16, 36, 99]} pageSize={36} />
|
||||
|
||||
## Unknown pages
|
||||
|
||||
Set `pagesUnknown` to `true` when the total number of pages is unknown. This renders the item range text without factoring in the total number of pages.
|
||||
|
||||
<Pagination pagesUnknown />
|
||||
|
||||
## Page window
|
||||
|
||||
The number of native select items rendered is derived from `totalItems`. For large datasets, this can impact performance. Use `pageWindow` to control the number of rendered items.
|
||||
|
||||
<Pagination totalItems={100_000} pageSizes={[10, 15, 20]} />
|
||||
<Pagination totalItems={102} pageSizes="{[16, 36, 99]}" pageSize="{36}" />
|
||||
|
||||
## Hidden page input
|
||||
|
||||
Disable the page input by setting `pageInputDisabled` to `true`.
|
||||
|
||||
<Pagination totalItems={102} pageInputDisabled />
|
||||
|
||||
## Hidden page size
|
||||
|
||||
Disable the page size selector by setting `pageSizeInputDisabled` to `true`.
|
||||
|
||||
<Pagination totalItems={102} pageSizeInputDisabled />
|
||||
|
||||
## Skeleton
|
||||
|
||||
Use `PaginationSkeleton` to show a loading state.
|
||||
|
||||
<PaginationSkeleton />
|
||||
|
|
|
|||
|
|
@ -3,11 +3,9 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`PaginationNav` provides a compact navigation interface for paginated content. It displays page numbers and navigation buttons, with support for overflow menus when there are many pages.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic pagination navigation with default settings.
|
||||
`PaginationNav` renders `10` items and does not loop by default.
|
||||
|
||||
<PaginationNav />
|
||||
|
||||
|
|
@ -17,35 +15,37 @@ Use the `page` prop to bind to the current page number.
|
|||
|
||||
<FileSource src="/framed/PaginationNav/PaginationNavReactive" />
|
||||
|
||||
## Total pages
|
||||
## Total
|
||||
|
||||
Specify the total number of pages using the `total` prop.
|
||||
Use the `total` prop to specify the number of pages.
|
||||
|
||||
<PaginationNav total={3} />
|
||||
|
||||
## Loop navigation
|
||||
## Loopable
|
||||
|
||||
Set `loop` to `true` to enable circular navigation between pages.
|
||||
Set `loop` to `true` for navigation to be looped.
|
||||
|
||||
<PaginationNav total={3} loop />
|
||||
|
||||
## Visible pages
|
||||
## Shown
|
||||
|
||||
Control the number of visible page numbers with the `shown` prop.
|
||||
If `total` is greater than `10`, the number of items shown will be truncated to `10`.
|
||||
|
||||
<PaginationNav total={100} shown={5} />
|
||||
Use `shown` to override the number of items shown.
|
||||
|
||||
<PaginationNav total={100} shown={5} />
|
||||
|
||||
## Custom button text
|
||||
|
||||
Customize the navigation button text using `forwardText` and `backwardText`.
|
||||
Use the `forwardText` and `backwardText` props to customize the button text.
|
||||
|
||||
<PaginationNav
|
||||
forwardText="Next"
|
||||
backwardText="Previous"
|
||||
/>
|
||||
|
||||
## Tooltip position
|
||||
## Tooltip Position
|
||||
|
||||
Set the tooltip position relative to the navigation buttons using `tooltipPosition`.
|
||||
Use the `tooltipPosition` prop to change the alignment of the tooltip.
|
||||
|
||||
<PaginationNav tooltipPosition="outside" total={3} loop />
|
||||
|
|
@ -3,12 +3,8 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`PasswordInput` provides a secure text input field with a visibility toggle for password entry. It includes features for validation, warnings, and accessibility.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic password input with a label and placeholder.
|
||||
|
||||
<PasswordInput labelText="Password" placeholder="Enter password..." />
|
||||
|
||||
## Custom tooltip alignment
|
||||
|
|
@ -25,54 +21,36 @@ Set prop `type` to `"text"` to toggle password visibility.
|
|||
|
||||
## Hidden label
|
||||
|
||||
Visually hide the label while maintaining accessibility.
|
||||
|
||||
<PasswordInput hideLabel labelText="Password" placeholder="Enter password..." />
|
||||
|
||||
## Light variant
|
||||
|
||||
Enable the light variant for use on dark backgrounds.
|
||||
|
||||
<PasswordInput light labelText="Password" placeholder="Enter password..." />
|
||||
|
||||
## Inline
|
||||
|
||||
Display the input with an inline label layout.
|
||||
|
||||
<PasswordInput inline labelText="Password" placeholder="Enter password..." />
|
||||
|
||||
## Extra-large size
|
||||
## Large size
|
||||
|
||||
Use the extra-large size variant for increased visibility.
|
||||
|
||||
<PasswordInput size="xl" labelText="Password" placeholder="Enter password..." />
|
||||
<PasswordInput size="lg" labelText="Password" placeholder="Enter password..." />
|
||||
|
||||
## Small size
|
||||
|
||||
Use the small size variant for compact layouts.
|
||||
|
||||
<PasswordInput size="sm" labelText="Password" placeholder="Enter password..." />
|
||||
|
||||
## Invalid state
|
||||
|
||||
Display an error message when the input is invalid.
|
||||
|
||||
<PasswordInput invalid invalidText="Incorrect user name or password." labelText="Password" placeholder="Enter password..." />
|
||||
|
||||
## Warning state
|
||||
|
||||
Show a warning message for non-critical issues.
|
||||
|
||||
<PasswordInput warn warnText="Password has been reset." labelText="Password" placeholder="Enter password..." />
|
||||
|
||||
## Disabled state
|
||||
|
||||
Disable the input to prevent user interaction.
|
||||
|
||||
<PasswordInput disabled labelText="Password" placeholder="Enter password..." />
|
||||
|
||||
## With helper text
|
||||
|
||||
Add helper text to provide additional context or instructions.
|
||||
|
||||
<PasswordInput helperText="Your password should be hard to guess" labelText="Password" placeholder="Enter password..." />
|
||||
|
|
|
|||
|
|
@ -1,40 +1,42 @@
|
|||
---
|
||||
components: ["Popover", "PopoverContent"]
|
||||
---
|
||||
|
||||
<script>
|
||||
import { Popover } from "carbon-components-svelte";
|
||||
import { Popover, PopoverContent } from "carbon-components-svelte";
|
||||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`Popover` provides a floating container that displays content relative to a trigger element. It supports various alignments, caret indicators, and visual variants.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic popover with absolute positioning.
|
||||
By default, the position of the popover component is absolute.
|
||||
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover open>
|
||||
<div style="padding: var(--cds-spacing-05)">Content</div>
|
||||
Parent
|
||||
<PopoverContent style="padding: var(--bx-spacing-05)">Content</PopoverContent>
|
||||
</Popover>
|
||||
</div>
|
||||
|
||||
## Relative position
|
||||
|
||||
Set `relative` to `true` to position the popover relative to its parent element.
|
||||
Set `relative` to `true` to use a relative position.
|
||||
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover relative open>
|
||||
<div style="padding: var(--cds-spacing-05)">Content</div>
|
||||
<div style="padding: var(--bx-spacing-05)">Content</div>
|
||||
</Popover>
|
||||
</div>
|
||||
|
||||
## Close on outside click
|
||||
|
||||
Enable automatic closing when clicking outside the popover using `closeOnOutsideClick`.
|
||||
Set `closeOnOutsideClick` to set `open` to `false` when clicking outside of the popover.
|
||||
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover open closeOnOutsideClick on:click:outside={() => {console.log('on:click:outside')}}>
|
||||
<div style="padding: var(--cds-spacing-05)">Content</div>
|
||||
<div style="padding: var(--bx-spacing-05)">Content</div>
|
||||
</Popover>
|
||||
</div>
|
||||
|
||||
|
|
@ -47,111 +49,107 @@ The default `align` value is `"top"`.
|
|||
<div data-outline>
|
||||
Parent
|
||||
<Popover open align="top-left">
|
||||
<div style="padding: var(--cds-spacing-05)">top-left</div>
|
||||
<div style="padding: var(--bx-spacing-05)">top-left</div>
|
||||
</Popover>
|
||||
</div>
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover open align="top-right">
|
||||
<div style="padding: var(--cds-spacing-05)">top-right</div>
|
||||
<div style="padding: var(--bx-spacing-05)">top-right</div>
|
||||
</Popover>
|
||||
</div>
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover open align="bottom">
|
||||
<div style="padding: var(--cds-spacing-05)">bottom</div>
|
||||
<div style="padding: var(--bx-spacing-05)">bottom</div>
|
||||
</Popover>
|
||||
</div>
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover open align="bottom-left">
|
||||
<div style="padding: var(--cds-spacing-05)">bottom-left</div>
|
||||
<div style="padding: var(--bx-spacing-05)">bottom-left</div>
|
||||
</Popover>
|
||||
</div>
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover open align="bottom-right">
|
||||
<div style="padding: var(--cds-spacing-05)">bottom-right</div>
|
||||
<div style="padding: var(--bx-spacing-05)">bottom-right</div>
|
||||
</Popover>
|
||||
</div>
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover open align="left">
|
||||
<div style="padding: var(--cds-spacing-05)">left</div>
|
||||
<div style="padding: var(--bx-spacing-05)">left</div>
|
||||
</Popover>
|
||||
</div>
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover open align="left-bottom">
|
||||
<div style="padding: var(--cds-spacing-05)">left-bottom</div>
|
||||
<div style="padding: var(--bx-spacing-05)">left-bottom</div>
|
||||
</Popover>
|
||||
</div>
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover open align="left-right">
|
||||
<div style="padding: var(--cds-spacing-05)">left-right</div>
|
||||
<div style="padding: var(--bx-spacing-05)">left-right</div>
|
||||
</Popover>
|
||||
</div>
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover open align="right">
|
||||
<div style="padding: var(--cds-spacing-05)">right</div>
|
||||
<div style="padding: var(--bx-spacing-05)">right</div>
|
||||
</Popover>
|
||||
</div>
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover open align="right-bottom">
|
||||
<div style="padding: var(--cds-spacing-05)">right-bottom</div>
|
||||
<div style="padding: var(--bx-spacing-05)">right-bottom</div>
|
||||
</Popover>
|
||||
</div>
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover open align="right-top">
|
||||
<div style="padding: var(--cds-spacing-05)">right-top</div>
|
||||
<div style="padding: var(--bx-spacing-05)">right-top</div>
|
||||
</Popover>
|
||||
</div>
|
||||
|
||||
## With caret
|
||||
|
||||
Add a caret indicator to the popover using the `caret` prop.
|
||||
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover caret open>
|
||||
<div style="padding: var(--cds-spacing-05)">Content</div>
|
||||
<div style="padding: var(--bx-spacing-05)">Content</div>
|
||||
</Popover>
|
||||
</div>
|
||||
|
||||
## Custom caret alignment
|
||||
|
||||
By default, the caret is aligned "top". Possible `align` values include `"top"`, `"top-left"`, `"top-right"`, `"bottom"`, `"bottom-left"`, `"bottom-right"`, `"left"`, `"left-bottom"`, `"left-top"`, `"right"`, `"right-bottom"` or `"right-top"`.
|
||||
By default, the caret is aligned "top".
|
||||
|
||||
Possible `align` values include `"top"`, `"top-left"`, `"top-right"`, `"bottom"`, `"bottom-left"`, `"bottom-right"`, `"left"`, `"left-bottom"`, `"left-top"`, `"right"`, `"right-bottom"` or `"right-top"`.
|
||||
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover caret align="top-left" open>
|
||||
<div style="padding: var(--cds-spacing-05)">Content</div>
|
||||
<div style="padding: var(--bx-spacing-05)">Content</div>
|
||||
</Popover>
|
||||
</div>
|
||||
|
||||
## Light variant
|
||||
|
||||
Enable the light variant for use on dark backgrounds.
|
||||
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover light open>
|
||||
<div style="padding: var(--cds-spacing-05)">Content</div>
|
||||
<div style="padding: var(--bx-spacing-05)">Content</div>
|
||||
</Popover>
|
||||
</div>
|
||||
|
||||
## High contrast variant
|
||||
|
||||
Enable the high contrast variant for improved visibility.
|
||||
|
||||
<div data-outline>
|
||||
Parent
|
||||
<Popover highContrast open>
|
||||
<div style="padding: var(--cds-spacing-05)">Content</div>
|
||||
<div style="padding: var(--bx-spacing-05)">Content</div>
|
||||
</Popover>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -3,70 +3,66 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`ProgressBar` provides a visual indicator of progress for operations such as file uploads or data processing. It supports determinate and indeterminate states, various sizes, and status indicators.
|
||||
|
||||
## Default
|
||||
|
||||
Create an indeterminate progress bar that continuously animates.
|
||||
Without a specified `value` prop, the progress bar is indeterminate.
|
||||
|
||||
<ProgressBar helperText="Loading..." />
|
||||
|
||||
## Small size
|
||||
|
||||
Use the small size variant for compact layouts.
|
||||
Specify `size="sm"` to use the small variant.
|
||||
|
||||
<ProgressBar size="sm" helperText="Loading..." />
|
||||
|
||||
## Percentage
|
||||
|
||||
Display progress as a percentage using the `value` prop.
|
||||
Specify a `value` for the progress bar to be determinate.
|
||||
|
||||
<ProgressBar value={40} labelText="Upload status" helperText="40 MB of 100 MB" />
|
||||
|
||||
## Finished status
|
||||
|
||||
Show completion status with a checkmark icon.
|
||||
Specify `status="finished"` for the progress bar.
|
||||
|
||||
<ProgressBar value={100} status="finished" labelText="Upload file" helperText="Upload complete" />
|
||||
|
||||
## Error status
|
||||
|
||||
Indicate errors with an error icon and red styling.
|
||||
Specify `status="error"` for the progress bar.
|
||||
|
||||
<ProgressBar value={0} status="error" labelText="Upload file" helperText="Invalid file format" />
|
||||
|
||||
## Custom max value
|
||||
|
||||
Set a custom maximum value for the progress bar.
|
||||
The default `max` value is `100`.
|
||||
|
||||
<ProgressBar value={40} max={200} labelText="Upload status" helperText="40 MB of 200 MB" />
|
||||
|
||||
## Hidden label
|
||||
|
||||
Visually hide the label while maintaining accessibility.
|
||||
It's recommended that you provide a `labelText` for accessibility.
|
||||
|
||||
Use `hideLabel` to visually hide the label text.
|
||||
|
||||
<ProgressBar hideLabel value={40} labelText="Upload status" helperText="40 MB of 100 MB" />
|
||||
|
||||
## Inline variant
|
||||
|
||||
Use the inline variant to display progress without helper text.
|
||||
The inline variant visually hides the `helperText`.
|
||||
|
||||
<ProgressBar kind="inline" value={40} labelText="Upload status" helperText="40 MB of 100 MB" />
|
||||
|
||||
## Indented variant
|
||||
|
||||
Use the indented variant for a more compact layout.
|
||||
|
||||
<ProgressBar kind="indented" value={40} labelText="Upload status" helperText="40 MB of 100 MB" />
|
||||
|
||||
## Indented status variant
|
||||
|
||||
Combine the indented variant with status indicators.
|
||||
|
||||
<ProgressBar kind="indented" status="finished" value={40} labelText="Upload file" helperText="Upload complete" />
|
||||
|
||||
## UX example
|
||||
|
||||
Demonstrate a complete upload flow with start and end states.
|
||||
This example shows how to animate the progress bar from 0 to 100% with start and end states.
|
||||
|
||||
<FileSource src="/framed/ProgressBar/ProgressBarUx" />
|
||||
|
|
@ -7,11 +7,7 @@ components: ["ProgressIndicator", "ProgressStep", "ProgressIndicatorSkeleton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`ProgressIndicator` provides a visual representation of progress through a sequence of steps. It supports horizontal and vertical layouts, step completion states, and interactive navigation.
|
||||
|
||||
## Default
|
||||
|
||||
Create a horizontal progress indicator with four steps.
|
||||
## Default (horizontal)
|
||||
|
||||
<ProgressIndicator currentIndex={2}>
|
||||
<ProgressStep complete
|
||||
|
|
@ -34,7 +30,9 @@ Create a horizontal progress indicator with four steps.
|
|||
|
||||
## Prevent change on click
|
||||
|
||||
Disable automatic step selection when clicking completed steps.
|
||||
By default, clicking any step that is complete will update the current step index.
|
||||
|
||||
Set `preventChangeOnClick` to `true` to prevent this behavior.
|
||||
|
||||
<ProgressIndicator preventChangeOnClick currentIndex={2}>
|
||||
<ProgressStep complete
|
||||
|
|
@ -57,14 +55,12 @@ Disable automatic step selection when clicking completed steps.
|
|||
|
||||
## Programmatic usage
|
||||
|
||||
Update the current step programmatically while maintaining step completion rules.
|
||||
When programmatically updating the `currentIndex`, keep in mind that only completed steps should be selectable.
|
||||
|
||||
<FileSource src="/framed/ProgressIndicator/ProgrammaticProgressIndicator" />
|
||||
|
||||
## Invalid step
|
||||
|
||||
Mark a step as invalid to indicate an error state.
|
||||
|
||||
<ProgressIndicator>
|
||||
<ProgressStep complete
|
||||
label="Step 1"
|
||||
|
|
@ -82,8 +78,6 @@ Mark a step as invalid to indicate an error state.
|
|||
|
||||
## Disabled steps
|
||||
|
||||
Disable specific steps to prevent user interaction.
|
||||
|
||||
<ProgressIndicator>
|
||||
<ProgressStep complete
|
||||
label="Step 1"
|
||||
|
|
@ -101,8 +95,6 @@ Disable specific steps to prevent user interaction.
|
|||
|
||||
## Spaced-equally
|
||||
|
||||
Distribute steps evenly across the available space.
|
||||
|
||||
<ProgressIndicator spaceEqually>
|
||||
<ProgressStep
|
||||
label="Really long label"
|
||||
|
|
@ -120,8 +112,6 @@ Distribute steps evenly across the available space.
|
|||
|
||||
## Vertical
|
||||
|
||||
Display steps in a vertical layout.
|
||||
|
||||
<ProgressIndicator vertical>
|
||||
<ProgressStep
|
||||
label="Really long label"
|
||||
|
|
@ -139,12 +129,10 @@ Display steps in a vertical layout.
|
|||
|
||||
## Skeleton
|
||||
|
||||
Show a loading state with the specified number of steps.
|
||||
Use the `count` prop to specify the number of progress steps to render.
|
||||
|
||||
<ProgressIndicatorSkeleton />
|
||||
|
||||
## Skeleton (vertical)
|
||||
|
||||
Show a vertical loading state with the specified number of steps.
|
||||
|
||||
<ProgressIndicatorSkeleton vertical />
|
||||
|
|
@ -7,11 +7,9 @@ components: ["RadioButtonGroup", "RadioButton", "RadioButtonSkeleton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`RadioButton` provides a selection control that allows users to choose a single option from a set. It supports both individual and grouped usage, with options for horizontal and vertical layouts.
|
||||
|
||||
## Default
|
||||
|
||||
Create a group of radio buttons with a shared name and legend.
|
||||
The `name` prop set on `RadioButtonGroup` is passed to the individual `RadioButton` inputs.
|
||||
|
||||
<RadioButtonGroup legendText="Storage tier (disk)" name="plan" selected="standard">
|
||||
<RadioButton labelText="Free (1 GB)" value="free" />
|
||||
|
|
@ -21,7 +19,9 @@ Create a group of radio buttons with a shared name and legend.
|
|||
|
||||
## Hidden legend
|
||||
|
||||
Visually hide the legend while maintaining accessibility.
|
||||
It's recommended that you provide a legend for accessibility.
|
||||
|
||||
Use `hideLegend` to visually hide the legend text.
|
||||
|
||||
<RadioButtonGroup hideLegend legendText="Storage tier (disk)" name="plan-legend" selected="standard">
|
||||
<RadioButton labelText="Free (1 GB)" value="free" />
|
||||
|
|
@ -31,7 +31,7 @@ Visually hide the legend while maintaining accessibility.
|
|||
|
||||
## Legend text slot
|
||||
|
||||
Customize the legend text with additional content.
|
||||
Use the named "legendText" slot to customize the legend text.
|
||||
|
||||
<RadioButtonGroup name="plan-legend-slot" selected="standard">
|
||||
<div slot="legendText" style:display="flex">
|
||||
|
|
@ -49,14 +49,12 @@ Customize the legend text with additional content.
|
|||
|
||||
## Reactive example
|
||||
|
||||
Bind and update the selected value programmatically.
|
||||
Use the `selected` prop to bind and update the selected value.
|
||||
|
||||
<FileSource src="/framed/RadioButton/RadioButtonReactive" />
|
||||
|
||||
## Left-aligned label text
|
||||
|
||||
Position labels to the left of the radio buttons.
|
||||
|
||||
<RadioButtonGroup labelPosition="left" legendText="Storage tier (disk)" name="plan-left-aligned" selected="standard">
|
||||
<RadioButton labelText="Free (1 GB)" value="free" />
|
||||
<RadioButton labelText="Standard (10 GB)" value="standard" />
|
||||
|
|
@ -65,8 +63,6 @@ Position labels to the left of the radio buttons.
|
|||
|
||||
## Disabled buttons
|
||||
|
||||
Disable specific radio buttons to prevent selection.
|
||||
|
||||
<RadioButtonGroup labelPosition="left" legendText="Storage tier (disk)" name="plan-disabled" selected="standard">
|
||||
<RadioButton disabled labelText="Free (1 GB)" value="free" />
|
||||
<RadioButton labelText="Standard (10 GB)" value="standard" />
|
||||
|
|
@ -75,8 +71,6 @@ Disable specific radio buttons to prevent selection.
|
|||
|
||||
## Vertical orientation
|
||||
|
||||
Display radio buttons in a vertical layout.
|
||||
|
||||
<RadioButtonGroup orientation="vertical" legendText="Storage tier (disk)" name="plan-vertical" selected="standard">
|
||||
<RadioButton labelText="Free (1 GB)" value="free" />
|
||||
<RadioButton labelText="Standard (10 GB)" value="standard" />
|
||||
|
|
@ -85,8 +79,6 @@ Display radio buttons in a vertical layout.
|
|||
|
||||
## Skeleton
|
||||
|
||||
Show a loading state for horizontal radio buttons.
|
||||
|
||||
<RadioButtonGroup legendText="Storage tier (disk)">
|
||||
<RadioButtonSkeleton />
|
||||
<RadioButtonSkeleton />
|
||||
|
|
@ -95,8 +87,6 @@ Show a loading state for horizontal radio buttons.
|
|||
|
||||
## Skeleton (vertical)
|
||||
|
||||
Show a loading state for vertical radio buttons.
|
||||
|
||||
<RadioButtonGroup orientation="vertical" legendText="Storage tier (disk)">
|
||||
<RadioButtonSkeleton />
|
||||
<RadioButtonSkeleton />
|
||||
|
|
|
|||
|
|
@ -7,12 +7,8 @@ components: ["TileGroup", "RadioTile"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`RadioTile` provides a selectable tile interface for choosing a single option from a set. It supports both individual and grouped usage, with options for light and disabled states.
|
||||
|
||||
## Default
|
||||
|
||||
Create a group of radio tiles with a shared name and legend.
|
||||
|
||||
<TileGroup legend="Service pricing tiers" name="plan" selected="standard">
|
||||
<RadioTile value="lite">
|
||||
Lite plan
|
||||
|
|
@ -27,20 +23,16 @@ Create a group of radio tiles with a shared name and legend.
|
|||
|
||||
## Reactive (one-way binding)
|
||||
|
||||
Update the selected value using the `select` event.
|
||||
|
||||
<FileSource src="/framed/RadioTile/RadioTileReactiveOneWay" />
|
||||
|
||||
## Reactive (two-way binding)
|
||||
|
||||
Bind to the `selected` prop for simpler state management.
|
||||
Binding to the `selected` prop is a more concise approach to managing state.
|
||||
|
||||
<FileSource src="/framed/RadioTile/RadioTileReactive" />
|
||||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for light backgrounds.
|
||||
|
||||
<TileGroup legend="Service pricing tiers" name="plan-light" selected="standard">
|
||||
<RadioTile light value="lite">
|
||||
Lite plan
|
||||
|
|
@ -55,8 +47,6 @@ Use the light variant for light backgrounds.
|
|||
|
||||
## Disabled state
|
||||
|
||||
Disable specific tiles to prevent selection.
|
||||
|
||||
<TileGroup legend="Service pricing tiers" name="plan-disabled" selected="standard">
|
||||
<RadioTile value="lite" disabled>
|
||||
Lite plan
|
||||
|
|
|
|||
|
|
@ -1,15 +1,11 @@
|
|||
<script>
|
||||
import { InlineNotification, RecursiveList, Link } from "carbon-components-svelte";
|
||||
import { InlineNotification, RecursiveList } from "carbon-components-svelte";
|
||||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`RecursiveList` provides a flexible way to render hierarchical data structures using either unordered or ordered lists. It supports nested nodes, links, and HTML content, making it ideal for displaying complex data hierarchies.
|
||||
This component uses the [svelte:self API](https://svelte.dev/docs#svelte_self) to render the [UnorderedList](/components/UnorderedList) and [OrderedList](/components/OrderedList) components with tree structured data.
|
||||
|
||||
<InlineNotification svx-ignore lowContrast title="Note:" kind="info" hideCloseButton>
|
||||
<div class="body-short-01">
|
||||
In version 0.86.0, the <strong>children</strong> prop was renamed to <strong>nodes</strong> for <Link target="_blank" href="https://svelte.dev/docs/svelte/v5-migration-guide#The-children-prop-is-reserved">Svelte 5 compatibility</Link>.
|
||||
</div>
|
||||
</InlineNotification>
|
||||
A child node can render text, a link, HTML content, and other children.
|
||||
|
||||
<InlineNotification svx-ignore lowContrast title="Warning:" kind="warning" hideCloseButton>
|
||||
<div class="body-short-01">
|
||||
|
|
@ -17,26 +13,22 @@
|
|||
</div>
|
||||
</InlineNotification>
|
||||
|
||||
## Default
|
||||
## Unordered
|
||||
|
||||
Create a hierarchical list using the `nodes` prop. Each node can contain text, links, HTML content, and nested nodes.
|
||||
The `children` prop accepts an array of child nodes.
|
||||
|
||||
By default, the list type is unordered.
|
||||
|
||||
<FileSource src="/framed/RecursiveList/RecursiveList" />
|
||||
|
||||
## Ordered
|
||||
|
||||
Set `type` to `"ordered"` to use numbered lists with proper indentation.
|
||||
Set `type` to `"ordered"` to use the ordered list variant.
|
||||
|
||||
<FileSource src="/framed/RecursiveList/RecursiveListOrdered" />
|
||||
|
||||
## Ordered (native styles)
|
||||
|
||||
Set `type` to `"ordered-native"` to use browser-native numbering styles.
|
||||
Set `type` to `"ordered-native"` to use the native styles for an ordered list.
|
||||
|
||||
<FileSource src="/framed/RecursiveList/RecursiveListOrderedNative" />
|
||||
|
||||
## Flat data structure
|
||||
|
||||
Convert flat data structures to hierarchical arrays using the `toHierarchy` utility function.
|
||||
|
||||
<FileSource src="/framed/RecursiveList/RecursiveListFlatArray" />
|
||||
|
|
|
|||
|
|
@ -4,72 +4,54 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`Search` provides a flexible search input component with support for expandable variants, different sizes, and custom icons. It includes built-in functionality for clearing input and handling keyboard events.
|
||||
|
||||
## Default
|
||||
|
||||
The search component is extra-large by default. Use the `size` prop to choose between [large](#large-size) and [small](#small-size) variants.
|
||||
The `Search` component size is medium by default. There are [large](#large-size) and [small](#small-size) size variants.
|
||||
|
||||
<Search />
|
||||
|
||||
## Default value
|
||||
|
||||
Set an initial value using the `value` prop.
|
||||
|
||||
<Search placeholder="Search catalog..." value="Cloud functions" />
|
||||
|
||||
## Reactive example
|
||||
|
||||
Bind to the `value` prop for reactive updates.
|
||||
|
||||
<FileSource src="/framed/Search/SearchReactive" />
|
||||
|
||||
## Clear event
|
||||
## on:clear
|
||||
|
||||
The `clear` event is dispatched when clicking the clear button or pressing the Escape key.
|
||||
The "clear" event is dispatched when clicking the "X" button or when pressing the "Escape" key.
|
||||
|
||||
<Search value="Cloud functions" on:clear={() => console.log('clear')}/>
|
||||
|
||||
## Expandable variant
|
||||
|
||||
Enable the expandable variant to show a compact search icon that expands on focus.
|
||||
Set `expandable` to `true` to use the expandable variant.
|
||||
|
||||
<FileSource src="/framed/Search/SearchExpandableReactive" />
|
||||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for light backgrounds.
|
||||
|
||||
<Search light />
|
||||
|
||||
## Large size
|
||||
|
||||
Set `size` to `"lg"` for a large search input.
|
||||
|
||||
<Search size="lg" />
|
||||
|
||||
## Small size
|
||||
|
||||
Set `size` to `"sm"` for a small search input.
|
||||
|
||||
<Search size="sm" />
|
||||
|
||||
## Disabled state
|
||||
|
||||
Disable the search input using the `disabled` prop.
|
||||
|
||||
<Search disabled />
|
||||
|
||||
## Custom icon
|
||||
|
||||
Replace the default search icon with a custom one.
|
||||
## Custom search icon
|
||||
|
||||
<Search icon={Query} />
|
||||
|
||||
## Skeleton
|
||||
|
||||
Display a loading state using the skeleton variant.
|
||||
|
||||
<Search skeleton />
|
||||
|
||||
## Skeleton (large)
|
||||
|
|
|
|||
|
|
@ -7,78 +7,65 @@ components: ["Select", "SelectItem", "SelectItemGroup", "SelectSkeleton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`Select` provides a dropdown menu for selecting a single option from a list. It supports various states, sizes, and includes built-in validation and helper text.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic select menu with `SelectItem` components. The first item's value is used as the default if `selected` is not set.
|
||||
If the `selected` prop is not set, the value of the first `SelectItem` will be used as the default value.
|
||||
|
||||
<Select labelText="Carbon theme" on:change={e => console.log("value", e.target.value)}>
|
||||
<SelectItem value="white" />
|
||||
<SelectItem value="g10" />
|
||||
<SelectItem value="g80" />
|
||||
<SelectItem value="g90" />
|
||||
<SelectItem value="g100" />
|
||||
</Select>
|
||||
|
||||
## Custom item text
|
||||
|
||||
Use the `text` prop to customize the display text of each option.
|
||||
Use the `text` prop on `SelectItem` to customize the display value.
|
||||
|
||||
<Select labelText="Carbon theme" on:change={e => console.log("value", e.target.value)}>
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
||||
## Initial selected value
|
||||
|
||||
Set the initial selection using the `selected` prop.
|
||||
Use the `selected` prop to specify an initial value.
|
||||
|
||||
<Select labelText="Carbon theme" selected="g10" on:change={e => console.log("value", e.target.value)}>
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
||||
## Reactive example
|
||||
|
||||
The `selected` prop supports two-way binding for reactive updates.
|
||||
The `selected` prop is reactive and supports two-way binding.
|
||||
|
||||
<FileSource src="/framed/Select/SelectReactive" />
|
||||
|
||||
## Helper text
|
||||
|
||||
Add descriptive text below the select menu.
|
||||
|
||||
<Select helperText="Carbon offers 4 themes (2 light, 3 dark)" labelText="Carbon theme" selected="g10" >
|
||||
<Select helperText="Carbon offers 4 themes (2 light, 2 dark)" labelText="Carbon theme" selected="g10" >
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
||||
## Hidden label
|
||||
|
||||
Visually hide the label while maintaining accessibility.
|
||||
|
||||
<Select hideLabel labelText="Carbon theme" selected="g10" >
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
||||
## Item groups
|
||||
|
||||
Group related options using `SelectItemGroup` components.
|
||||
|
||||
<Select labelText="Carbon theme" selected="0">
|
||||
<SelectItem value="0" text="Select a theme" disabled hidden />
|
||||
<SelectItemGroup label="Light theme">
|
||||
|
|
@ -86,100 +73,76 @@ Group related options using `SelectItemGroup` components.
|
|||
<SelectItem value="g10" text="Gray 10" />
|
||||
</SelectItemGroup>
|
||||
<SelectItemGroup label="Dark theme">
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</SelectItemGroup>
|
||||
</Select>
|
||||
|
||||
## Small size
|
||||
## Light variant
|
||||
|
||||
Use the small size variant for compact layouts.
|
||||
|
||||
<Select size="sm" labelText="Carbon theme" selected="g10" >
|
||||
<Select light labelText="Carbon theme" selected="g10" >
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
||||
## Extra-large size
|
||||
|
||||
Use the extra-large size variant for prominent selections.
|
||||
|
||||
<Select size="xl" labelText="Carbon theme" selected="g10" >
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
||||
## Inline variant
|
||||
|
||||
Use the inline variant for horizontal layouts.
|
||||
|
||||
<Select inline labelText="Carbon theme" selected="g10" >
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
||||
## Light variant
|
||||
## Large size
|
||||
|
||||
Use the light variant for light backgrounds.
|
||||
|
||||
<Select light labelText="Carbon theme" selected="g10" >
|
||||
<Select size="lg" labelText="Carbon theme" selected="g10" >
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
||||
## Small size
|
||||
|
||||
<Select size="sm" labelText="Carbon theme" selected="g10" >
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
||||
## Invalid state
|
||||
|
||||
Show validation errors using the invalid state.
|
||||
|
||||
<Select invalid invalidText="Theme must be a dark variant" labelText="Carbon theme" selected="g10" >
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
||||
## Warning state
|
||||
|
||||
Show warnings using the warning state.
|
||||
|
||||
<Select warn warnText="The selected theme will not be persisted" labelText="Carbon theme" selected="g10" >
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
||||
## Disabled state
|
||||
|
||||
Disable the select menu to prevent interaction.
|
||||
|
||||
<Select disabled labelText="Carbon theme" selected="g10" >
|
||||
<SelectItem value="white" text="White" />
|
||||
<SelectItem value="g10" text="Gray 10" />
|
||||
<SelectItem value="g80" text="Gray 80" />
|
||||
<SelectItem value="g90" text="Gray 90" />
|
||||
<SelectItem value="g100" text="Gray 100" />
|
||||
</Select>
|
||||
|
||||
## Skeleton
|
||||
|
||||
Display a loading state using the skeleton variant.
|
||||
|
||||
<SelectSkeleton />
|
||||
|
||||
## Skeleton (hidden label)
|
||||
|
|
|
|||
|
|
@ -7,12 +7,8 @@ components: ["SelectableTile"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`SelectableTile` provides a tile-based selection interface that allows users to select multiple options. It supports various states and includes built-in keyboard navigation and accessibility features.
|
||||
|
||||
## Multi-selectable tiles
|
||||
|
||||
Group multiple selectable tiles together for multi-selection scenarios.
|
||||
|
||||
<div role="group" aria-label="selectable tiles">
|
||||
<SelectableTile selected>
|
||||
Multi-select Tile
|
||||
|
|
@ -27,8 +23,6 @@ Group multiple selectable tiles together for multi-selection scenarios.
|
|||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for light backgrounds.
|
||||
|
||||
<div role="group" aria-label="selectable tiles">
|
||||
<SelectableTile light selected>
|
||||
Multi-select Tile
|
||||
|
|
@ -43,8 +37,6 @@ Use the light variant for light backgrounds.
|
|||
|
||||
## Disabled state
|
||||
|
||||
Disable tiles to prevent interaction.
|
||||
|
||||
<div role="group" aria-label="selectable tiles">
|
||||
<SelectableTile selected>
|
||||
Multi-select Tile
|
||||
|
|
|
|||
|
|
@ -3,16 +3,10 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`SkeletonPlaceholder` provides a loading state placeholder that can be used to indicate content is being loaded. It supports custom sizing and forwards mouse events for interactive loading states.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic skeleton placeholder with default styling.
|
||||
|
||||
<SkeletonPlaceholder />
|
||||
|
||||
## Custom size
|
||||
|
||||
Specify custom dimensions using the `style` prop.
|
||||
|
||||
<SkeletonPlaceholder style="height: 12rem; width: 12rem;" />
|
||||
|
|
|
|||
|
|
@ -3,34 +3,22 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`SkeletonText` provides a loading state for text content with support for different sizes and line counts. It's commonly used to indicate that text content is being loaded.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic skeleton text with default styling.
|
||||
|
||||
<SkeletonText />
|
||||
|
||||
## Heading variant
|
||||
|
||||
Use the heading variant for larger text placeholders.
|
||||
|
||||
<SkeletonText heading />
|
||||
|
||||
## Paragraph variant
|
||||
|
||||
Use the paragraph variant for multi-line text placeholders.
|
||||
|
||||
<SkeletonText paragraph />
|
||||
|
||||
## Paragraph with custom line count
|
||||
|
||||
Specify the number of lines to render using the `lines` prop.
|
||||
|
||||
<SkeletonText paragraph lines={8} />
|
||||
|
||||
## Paragraph with max width
|
||||
|
||||
Set a custom width for the text placeholder using the `width` prop.
|
||||
|
||||
<SkeletonText paragraph width="50%" />
|
||||
|
|
@ -7,12 +7,8 @@ components: ["Slider", "SliderSkeleton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`Slider` provides a visual way to select a value from a range. It supports keyboard navigation, custom ranges, step values, and various states.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic slider with a label and default range (0-100).
|
||||
|
||||
<Slider labelText="Instances" value={0} />
|
||||
|
||||
## Full width
|
||||
|
|
@ -23,54 +19,36 @@ Set `fullWidth` to `true` for the slider to span the full width of its containin
|
|||
|
||||
## Hidden label
|
||||
|
||||
Visually hide the label while maintaining accessibility.
|
||||
|
||||
<Slider labelText="Instances" hideLabel value={0} />
|
||||
|
||||
## Hidden text input
|
||||
|
||||
Hide the text input while keeping the slider functionality.
|
||||
|
||||
<Slider labelText="Instances" hideTextInput value={0} />
|
||||
|
||||
## Custom minimum, maximum values
|
||||
|
||||
Set custom range values and labels.
|
||||
|
||||
<Slider labelText="Runtime memory (MB)" min={10} max={990} maxLabel="990 MB" value={100} />
|
||||
|
||||
## Custom step value
|
||||
|
||||
Specify the step value for more precise control.
|
||||
|
||||
<Slider labelText="Runtime memory (MB)" min={10} max={990} maxLabel="990 MB" value={100} step={10} />
|
||||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for light backgrounds.
|
||||
|
||||
<Slider light labelText="Runtime memory (MB)" min={10} max={990} maxLabel="990 MB" value={100} step={10} />
|
||||
<Slider light labelText="Runtime memory (MB)" min={10} max={990} maxLabel="990 MB" value={100} step={10} />
|
||||
|
||||
## Invalid state
|
||||
|
||||
Indicate an invalid state with the `invalid` prop.
|
||||
|
||||
<Slider invalid labelText="Runtime memory (MB)" min={10} max={990} maxLabel="990 MB" value={100} step={10} />
|
||||
<Slider invalid labelText="Runtime memory (MB)" min={10} max={990} maxLabel="990 MB" value={100} step={10} />
|
||||
|
||||
## Disabled state
|
||||
|
||||
Disable the slider to prevent interaction.
|
||||
|
||||
<Slider disabled labelText="Runtime memory (MB)" min={10} max={990} maxLabel="990 MB" value={100} step={10} />
|
||||
<Slider disabled labelText="Runtime memory (MB)" min={10} max={990} maxLabel="990 MB" value={100} step={10} />
|
||||
|
||||
## Skeleton
|
||||
|
||||
Show a loading state with the skeleton variant.
|
||||
|
||||
<SliderSkeleton />
|
||||
|
||||
## Skeleton (hidden label)
|
||||
|
||||
Show a loading state without a label.
|
||||
|
||||
<SliderSkeleton hideLabel />
|
||||
|
|
@ -3,16 +3,12 @@ components: ["StructuredList", "StructuredListSkeleton", "StructuredListBody", "
|
|||
---
|
||||
|
||||
<script>
|
||||
import { StructuredList, StructuredListSkeleton, StructuredListBody, StructuredListHead, StructuredListCell, StructuredListRow, StructuredListInput } from "carbon-components-svelte";
|
||||
import { StructuredList, StructuredListSkeleton, StructuredListBody, StructuredListHead, StructuredListCell ,StructuredListRow, StructuredListInput } from "carbon-components-svelte";
|
||||
import CheckmarkFilled from "carbon-icons-svelte/lib/CheckmarkFilled.svelte";
|
||||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`StructuredList` provides a semantic way to display tabular data with support for selection, keyboard navigation, and various layout options.
|
||||
|
||||
## Default
|
||||
|
||||
Display a basic structured list with headers and rows by default.
|
||||
## Default (read-only)
|
||||
|
||||
<StructuredList>
|
||||
<StructuredListHead>
|
||||
|
|
@ -24,27 +20,40 @@ Display a basic structured list with headers and rows by default.
|
|||
</StructuredListHead>
|
||||
<StructuredListBody>
|
||||
<StructuredListRow>
|
||||
<StructuredListCell noWrap>Row 1</StructuredListCell>
|
||||
<StructuredListCell>Row 1</StructuredListCell>
|
||||
<StructuredListCell>Row 1</StructuredListCell>
|
||||
<StructuredListCell>Row 1</StructuredListCell>
|
||||
<StructuredListCell>
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc dui
|
||||
magna, finibus id tortor sed, aliquet bibendum augue. Aenean posuere
|
||||
sem vel euismod dignissim. Nulla ut cursus dolor. Pellentesque
|
||||
vulputate nisl a porttitor interdum.
|
||||
</StructuredListCell>
|
||||
</StructuredListRow>
|
||||
<StructuredListRow>
|
||||
<StructuredListCell noWrap>Row 2</StructuredListCell>
|
||||
<StructuredListCell>Row 2</StructuredListCell>
|
||||
<StructuredListCell>Row 2</StructuredListCell>
|
||||
<StructuredListCell>Row 2</StructuredListCell>
|
||||
<StructuredListCell>
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc dui
|
||||
magna, finibus id tortor sed, aliquet bibendum augue. Aenean posuere
|
||||
sem vel euismod dignissim. Nulla ut cursus dolor. Pellentesque
|
||||
vulputate nisl a porttitor interdum.
|
||||
</StructuredListCell>
|
||||
</StructuredListRow>
|
||||
<StructuredListRow>
|
||||
<StructuredListCell noWrap>Row 3</StructuredListCell>
|
||||
<StructuredListCell>Row 3</StructuredListCell>
|
||||
<StructuredListCell>Row 3</StructuredListCell>
|
||||
<StructuredListCell>Row 3</StructuredListCell>
|
||||
<StructuredListCell>
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc dui
|
||||
magna, finibus id tortor sed, aliquet bibendum augue. Aenean posuere
|
||||
sem vel euismod dignissim. Nulla ut cursus dolor. Pellentesque
|
||||
vulputate nisl a porttitor interdum.
|
||||
</StructuredListCell>
|
||||
</StructuredListRow>
|
||||
</StructuredListBody>
|
||||
</StructuredList>
|
||||
|
||||
## Condensed variant
|
||||
|
||||
Use the condensed variant for more compact rows.
|
||||
|
||||
<StructuredList condensed>
|
||||
<StructuredListHead>
|
||||
<StructuredListRow head>
|
||||
|
|
@ -55,26 +64,39 @@ Use the condensed variant for more compact rows.
|
|||
</StructuredListHead>
|
||||
<StructuredListBody>
|
||||
<StructuredListRow>
|
||||
<StructuredListCell noWrap>Row 1</StructuredListCell>
|
||||
<StructuredListCell>Row 1</StructuredListCell>
|
||||
<StructuredListCell>Row 1</StructuredListCell>
|
||||
<StructuredListCell>Row 1</StructuredListCell>
|
||||
<StructuredListCell>
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc dui
|
||||
magna, finibus id tortor sed, aliquet bibendum augue. Aenean posuere
|
||||
sem vel euismod dignissim. Nulla ut cursus dolor. Pellentesque
|
||||
vulputate nisl a porttitor interdum.
|
||||
</StructuredListCell>
|
||||
</StructuredListRow>
|
||||
<StructuredListRow>
|
||||
<StructuredListCell noWrap>Row 2</StructuredListCell>
|
||||
<StructuredListCell>Row 2</StructuredListCell>
|
||||
<StructuredListCell>Row 2</StructuredListCell>
|
||||
<StructuredListCell>Row 2</StructuredListCell>
|
||||
<StructuredListCell>
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc dui
|
||||
magna, finibus id tortor sed, aliquet bibendum augue. Aenean posuere
|
||||
sem vel euismod dignissim. Nulla ut cursus dolor. Pellentesque
|
||||
vulputate nisl a porttitor interdum.
|
||||
</StructuredListCell>
|
||||
</StructuredListRow>
|
||||
<StructuredListRow>
|
||||
<StructuredListCell noWrap>Row 3</StructuredListCell>
|
||||
<StructuredListCell>Row 3</StructuredListCell>
|
||||
<StructuredListCell>Row 3</StructuredListCell>
|
||||
<StructuredListCell>Row 3</StructuredListCell>
|
||||
<StructuredListCell>
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc dui
|
||||
magna, finibus id tortor sed, aliquet bibendum augue. Aenean posuere
|
||||
sem vel euismod dignissim. Nulla ut cursus dolor. Pellentesque
|
||||
vulputate nisl a porttitor interdum.
|
||||
</StructuredListCell>
|
||||
</StructuredListRow>
|
||||
</StructuredListBody>
|
||||
</StructuredList>
|
||||
|
||||
## Flush variant
|
||||
|
||||
Use the flush variant to remove padding from the list.
|
||||
## Flush
|
||||
|
||||
<StructuredList flush>
|
||||
<StructuredListHead>
|
||||
|
|
@ -120,8 +142,6 @@ Use the flush variant to remove padding from the list.
|
|||
|
||||
## Selectable rows
|
||||
|
||||
Enable row selection with the `selection` prop and `StructuredListInput` components.
|
||||
|
||||
<StructuredList selection selected="row-1-value">
|
||||
<StructuredListHead>
|
||||
<StructuredListRow head>
|
||||
|
|
@ -162,6 +182,4 @@ Enable row selection with the `selection` prop and `StructuredListInput` compone
|
|||
|
||||
## Skeleton
|
||||
|
||||
Show a loading state with the skeleton variant.
|
||||
|
||||
<StructuredListSkeleton rows={3} />
|
||||
|
|
@ -7,12 +7,8 @@ components: ["Tabs", "Tab", "TabContent", "TabsSkeleton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`Tabs` provides a way to organize content into separate views that can be switched between. It supports keyboard navigation, disabled states, and various layout options.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic tab interface with labels and content.
|
||||
|
||||
<Tabs>
|
||||
<Tab label="Tab label 1" />
|
||||
<Tab label="Tab label 2" />
|
||||
|
|
@ -26,7 +22,9 @@ Create a basic tab interface with labels and content.
|
|||
|
||||
## Auto width
|
||||
|
||||
By default, each tab has a fixed width of `10rem`. Set `autoWidth` to `true` for tabs to automatically adjust their width based on content.
|
||||
By default, the width of each tab is set to `10rem`.
|
||||
|
||||
Set `autoWidth` to `true` for tabs to have an automatically set width.
|
||||
|
||||
<Tabs autoWidth>
|
||||
<Tab label="Tab label 1" />
|
||||
|
|
@ -41,13 +39,13 @@ By default, each tab has a fixed width of `10rem`. Set `autoWidth` to `true` for
|
|||
|
||||
## Reactive example
|
||||
|
||||
Use `bind:selected` to create a two-way binding with the selected tab index. This allows you to programmatically control the selected tab and react to tab changes.
|
||||
|
||||
<FileSource src="/framed/Tabs/TabsReactive" />
|
||||
|
||||
## Disabled tabs
|
||||
|
||||
Set `disabled` to `true` on a `Tab` component to prevent interaction. Keyboard navigation will skip disabled tabs.
|
||||
Setting `disabled` to `true` on the `Tab` component will prevent it from being clickable.
|
||||
|
||||
Using keyboard navigation (left and right arrow keys) will skip to the next non-disabled tab.
|
||||
|
||||
<Tabs>
|
||||
<Tab label="Tab label 1" />
|
||||
|
|
@ -62,11 +60,9 @@ Set `disabled` to `true` on a `Tab` component to prevent interaction. Keyboard n
|
|||
</svelte:fragment>
|
||||
</Tabs>
|
||||
|
||||
## Container type
|
||||
## Contained
|
||||
|
||||
Use the container type for a more prominent tab interface.
|
||||
|
||||
<Tabs type="container">
|
||||
<Tabs contained>
|
||||
<Tab label="Tab label 1" />
|
||||
<Tab label="Tab label 2" />
|
||||
<Tab label="Tab label 3" />
|
||||
|
|
@ -79,12 +75,8 @@ Use the container type for a more prominent tab interface.
|
|||
|
||||
## Skeleton (default)
|
||||
|
||||
Show a loading state with the default skeleton variant.
|
||||
|
||||
<TabsSkeleton count={3} />
|
||||
|
||||
## Skeleton (container)
|
||||
## Skeleton (contained)
|
||||
|
||||
Show a loading state with the container skeleton variant.
|
||||
|
||||
<TabsSkeleton type="container" count={3} />
|
||||
<TabsSkeleton contained count={3} />
|
||||
|
|
@ -1,31 +1,19 @@
|
|||
---
|
||||
components: ["Tag", "TagSkeleton"]
|
||||
---
|
||||
|
||||
<script>
|
||||
import { Tag, TooltipDefinition } from "carbon-components-svelte";
|
||||
import { Tag } from "carbon-components-svelte";
|
||||
import IbmCloud from "carbon-icons-svelte/lib/IbmCloud.svelte";
|
||||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`Tag` provides a way to categorize content with a keyword or label. It supports various styles, sizes, and interactive states, including filterable and interactive variants.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic tag with text content.
|
||||
|
||||
<Tag>IBM Cloud</Tag>
|
||||
|
||||
## Small size
|
||||
|
||||
Use the small size variant for more compact layouts.
|
||||
|
||||
<Tag size="sm">IBM Cloud</Tag>
|
||||
|
||||
## Tag types
|
||||
|
||||
Choose from a variety of color types to match your design system.
|
||||
|
||||
<Tag type="red">red</Tag>
|
||||
<Tag type="magenta">magenta</Tag>
|
||||
<Tag type="purple">purple</Tag>
|
||||
|
|
@ -41,59 +29,39 @@ Choose from a variety of color types to match your design system.
|
|||
|
||||
## Filterable
|
||||
|
||||
Create a filterable tag with a close button that dispatches a `close` event when clicked.
|
||||
|
||||
<Tag filter on:close>carbon-components</Tag>
|
||||
|
||||
## Filterable (disabled)
|
||||
|
||||
Disable a filterable tag to prevent interaction.
|
||||
|
||||
<Tag filter disabled on:close>carbon-components</Tag>
|
||||
|
||||
## Filterable (small)
|
||||
|
||||
Combine the filterable variant with the small size.
|
||||
|
||||
<Tag size="sm" filter on:close>carbon-components</Tag>
|
||||
|
||||
## Custom icon
|
||||
|
||||
Add a custom icon to the tag. Note: custom icons cannot be used with the filterable variant.
|
||||
Note: rendering a custom icon cannot be used with the filterable variant.
|
||||
|
||||
<Tag icon={IbmCloud}>IBM Cloud</Tag>
|
||||
|
||||
## Interactive variant
|
||||
|
||||
Set `interactive` to `true` to render a `button` element instead of a `div`. This is useful for clickable tags.
|
||||
Set `interactive` to `true` to render a `button` element instead of a `div`.
|
||||
|
||||
<Tag interactive>Machine learning</Tag>
|
||||
|
||||
## Disabled
|
||||
|
||||
Both filterable and interactive tag variants support a disabled state.
|
||||
The filterable and interactive tag variants have a disabled state.
|
||||
|
||||
<Tag filter disabled>Machine learning</Tag>
|
||||
<Tag interactive disabled>Machine learning</Tag>
|
||||
|
||||
## Tooltip in a tag
|
||||
|
||||
Embed a tooltip within a tag to provide additional context.
|
||||
|
||||
<Tag>
|
||||
<TooltipDefinition tooltipText="IBM Corporate Headquarters is based in Armonk, New York.">
|
||||
Armonk
|
||||
</TooltipDefinition>
|
||||
</Tag>
|
||||
|
||||
## Skeleton
|
||||
|
||||
Show a loading state with the default skeleton variant.
|
||||
|
||||
<Tag skeleton />
|
||||
|
||||
## Skeleton (small)
|
||||
|
||||
Show a loading state with the small skeleton variant.
|
||||
|
||||
<Tag size="sm" skeleton />
|
||||
|
|
@ -7,64 +7,46 @@ components: ["TextArea", "TextAreaSkeleton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`TextArea` provides a multi-line text input field with support for various states, character counting, and accessibility features. It's ideal for longer text input like descriptions, comments, or messages.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic textarea with a label and placeholder text.
|
||||
|
||||
<TextArea labelText="App description" placeholder="Enter a description..." />
|
||||
|
||||
## Maximum character count
|
||||
|
||||
Specify the max character count using the `maxCount` prop. A character counter will be displayed to the right of the label. You can also use the native `maxlength` attribute if you prefer not to show a counter.
|
||||
Specify the max character count using the `maxCount` prop. A character counter will be displayed to the right of the label.
|
||||
|
||||
You can always use the native `maxlength` attribute if you'd prefer that a counter not be shown.
|
||||
|
||||
<TextArea labelText="App description" placeholder="Enter a description..." maxCount={100} />
|
||||
|
||||
## With helper text
|
||||
|
||||
Add helper text below the textarea to provide additional context or instructions.
|
||||
|
||||
<TextArea labelText="App description" helperText="A rich description helps us better recommend related products and services" placeholder="Enter a description..." />
|
||||
|
||||
## Hidden label
|
||||
|
||||
Visually hide the label while maintaining accessibility by setting `hideLabel` to `true`.
|
||||
|
||||
<TextArea hideLabel labelText="App description" placeholder="Enter a description..." />
|
||||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for light-themed backgrounds by setting `light` to `true`.
|
||||
|
||||
<TextArea light labelText="App description" placeholder="Enter a description..." />
|
||||
|
||||
## Custom rows
|
||||
|
||||
Adjust the number of visible rows using the `rows` prop. The default is 4 rows.
|
||||
|
||||
<TextArea rows={10} labelText="App description" placeholder="Enter a description..." />
|
||||
|
||||
## Invalid state
|
||||
|
||||
Indicate an invalid state with an error message by setting `invalid` to `true` and providing `invalidText`.
|
||||
|
||||
<TextArea invalid invalidText="Only plain text characters are allowed" labelText="App description" placeholder="Enter a description..." />
|
||||
|
||||
## Disabled state
|
||||
|
||||
Disable the textarea to prevent user interaction by setting `disabled` to `true`.
|
||||
|
||||
<TextArea disabled labelText="App description" placeholder="Enter a description..." />
|
||||
|
||||
## Skeleton
|
||||
|
||||
Show a loading state with the default skeleton variant.
|
||||
|
||||
<TextAreaSkeleton />
|
||||
|
||||
## Skeleton without label
|
||||
|
||||
Show a loading state without a label by setting `hideLabel` to `true`.
|
||||
|
||||
<TextAreaSkeleton hideLabel />
|
||||
|
|
@ -7,82 +7,54 @@ components: ["TextInput", "TextInputSkeleton"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`TextInput` provides a single-line text input field with support for various states, sizes, and accessibility features. It's ideal for short text input like usernames, search terms, or form fields.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic text input with a label and placeholder text.
|
||||
|
||||
<TextInput labelText="User name" placeholder="Enter user name..." />
|
||||
|
||||
## With helper text
|
||||
|
||||
Add helper text below the input to provide additional context or instructions.
|
||||
|
||||
<TextInput labelText="User name" helperText="Your user name is associated with your email" placeholder="Enter user name..." />
|
||||
|
||||
## Hidden label
|
||||
|
||||
Visually hide the label while maintaining accessibility by setting `hideLabel` to `true`.
|
||||
|
||||
<TextInput hideLabel labelText="User name" placeholder="Enter user name..." />
|
||||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for light-themed backgrounds by setting `light` to `true`.
|
||||
|
||||
<TextInput light labelText="User name" placeholder="Enter user name..." />
|
||||
|
||||
## Inline variant
|
||||
|
||||
Use the inline variant to display the label and input on the same line by setting `inline` to `true`.
|
||||
|
||||
<TextInput inline labelText="User name" placeholder="Enter user name..." />
|
||||
|
||||
## Read-only variant
|
||||
|
||||
Display a non-editable value by setting `readonly` to `true`.
|
||||
|
||||
<TextInput readonly labelText="User name" value="IBM" />
|
||||
|
||||
## Extra-large size
|
||||
## Large size
|
||||
|
||||
Use the extra-large size for more prominent inputs by setting `size` to `"xl"`.
|
||||
|
||||
<TextInput size="xl" labelText="User name" placeholder="Enter user name..." />
|
||||
<TextInput size="lg" labelText="User name" placeholder="Enter user name..." />
|
||||
|
||||
## Small size
|
||||
|
||||
Use the small size for more compact inputs by setting `size` to `"sm"`.
|
||||
|
||||
<TextInput size="sm" labelText="User name" placeholder="Enter user name..." />
|
||||
|
||||
## Invalid state
|
||||
|
||||
Indicate an invalid state with an error message by setting `invalid` to `true` and providing `invalidText`.
|
||||
|
||||
<TextInput invalid invalidText="User name is already taken. Please try another." labelText="User name" placeholder="Enter user name..." />
|
||||
|
||||
## Warning state
|
||||
|
||||
Indicate a warning state with a message by setting `warn` to `true` and providing `warnText`.
|
||||
|
||||
<TextInput warn warnText="Your user name is different from your log in ID." labelText="User name" placeholder="Enter user name..." />
|
||||
|
||||
## Disabled state
|
||||
|
||||
Disable the input to prevent user interaction by setting `disabled` to `true`.
|
||||
|
||||
<TextInput disabled labelText="User name" placeholder="Enter user name..." />
|
||||
|
||||
## Skeleton
|
||||
|
||||
Show a loading state with the default skeleton variant.
|
||||
|
||||
<TextInputSkeleton />
|
||||
|
||||
## Skeleton without label
|
||||
|
||||
Show a loading state without a label by setting `hideLabel` to `true`.
|
||||
|
||||
<TextInputSkeleton hideLabel />
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
components: ["Theme"]
|
||||
---
|
||||
|
||||
<script>
|
||||
import { InlineNotification, CodeSnippet } from "carbon-components-svelte";
|
||||
import Preview from "../../components/Preview.svelte";
|
||||
|
|
@ -9,7 +5,7 @@ components: ["Theme"]
|
|||
let code = `import "carbon-components-svelte/css/all.css";`;
|
||||
</script>
|
||||
|
||||
The `Theme` component provides dynamic client-side theming using CSS variables. It supports five Carbon themes: white, g10, g80, g90, and g100, and allows for custom theme token overrides. The component can persist theme preferences using [window.localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) and provides built-in toggle and select controls for theme switching.
|
||||
The `Theme` component can dyanmically update the Carbon theme on the client-side. It can persist the theme locally using [window.localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
|
||||
|
||||
<InlineNotification svx-ignore lowContrast title="Note:" kind="info" hideCloseButton>
|
||||
<div class="body-short-01">You must use the "all.css" StyleSheet with the <code>Theme</code> component.</div>
|
||||
|
|
@ -21,42 +17,40 @@ The `all.css` StyleSheet uses [CSS variables](https://developer.mozilla.org/en-U
|
|||
|
||||
## Default
|
||||
|
||||
Create a basic theme component that can be controlled programmatically.
|
||||
|
||||
<FileSource src="/framed/Theme/Theme" />
|
||||
|
||||
## Persist locally
|
||||
|
||||
Set `persist` to `true` to save the theme preference in [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). Use `persistKey` to specify a custom storage key.
|
||||
Set `persist` to `true` to persist the theme locally using the [Window.localStorage API](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
|
||||
|
||||
<FileSource src="/framed/Theme/ThemePersist" />
|
||||
|
||||
## Custom theme
|
||||
|
||||
Override default Carbon theme tokens by providing custom key-value pairs in the `tokens` prop. Refer to the [Carbon website](https://carbondesignsystem.com/guidelines/themes/overview#customizing-a-theme) for guidance on customizing themes.
|
||||
Define keys and values in the `tokens` prop that override default Carbon theme tokens. Refer to the [Carbon website](https://carbondesignsystem.com/guidelines/themes/overview#customizing-a-theme) for guidance on customizing a theme using token values.
|
||||
|
||||
<FileSource src="/framed/Theme/ThemeTokens" />
|
||||
|
||||
## Theme toggle
|
||||
|
||||
Set `render` to `"toggle"` to display a toggle switch for switching between two themes. By default, it toggles between "white" and "g100" themes.
|
||||
Set `render` to `"toggle"` to render a toggle switch to control the theme.
|
||||
|
||||
<FileSource src="/framed/Theme/ThemeToggle" />
|
||||
|
||||
## Theme toggle (custom)
|
||||
|
||||
Customize the toggle appearance and behavior using the `toggle` prop. You can specify custom themes, labels, and other toggle properties.
|
||||
Customize the toggle using the `toggle` prop.
|
||||
|
||||
<FileSource src="/framed/Theme/ThemeToggleCustom" />
|
||||
|
||||
## Theme select
|
||||
|
||||
Set `render` to `"select"` to display a dropdown menu for selecting from all available themes.
|
||||
Set `render` to `"select"` to render a select dropdown to control the theme.
|
||||
|
||||
<FileSource src="/framed/Theme/ThemeSelect" />
|
||||
|
||||
## Theme select (custom)
|
||||
|
||||
Customize the select dropdown using the `select` prop. You can specify which themes to include, customize labels, and adjust other select properties.
|
||||
Customize the select using the `select` prop.
|
||||
|
||||
<FileSource src="/framed/Theme/ThemeSelectCustom" />
|
||||
|
|
@ -3,16 +3,10 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`Tile` provides a container for displaying content in a structured, card-like format. It supports light and dark variants and can be used to create consistent, visually distinct content sections.
|
||||
|
||||
## Default
|
||||
|
||||
Create a basic tile container for your content.
|
||||
|
||||
<Tile>Content</Tile>
|
||||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for light-themed backgrounds by setting `light` to `true`.
|
||||
|
||||
<Tile light>Content</Tile>
|
||||
|
|
@ -7,8 +7,6 @@ components: ["TimePicker", "TimePickerSelect", "SelectItem"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`TimePicker` provides a time input field with optional period (AM/PM) and timezone selectors. It supports various sizes, states, and themes to match your application's design system.
|
||||
|
||||
## Default
|
||||
|
||||
<TimePicker labelText="Cron job" placeholder="hh:mm">
|
||||
|
|
@ -24,8 +22,6 @@ components: ["TimePicker", "TimePickerSelect", "SelectItem"]
|
|||
|
||||
## Light variant
|
||||
|
||||
Use the light variant for light-themed backgrounds by setting `light` to `true`.
|
||||
|
||||
<TimePicker light labelText="Cron job" placeholder="hh:mm">
|
||||
<TimePickerSelect value="pm">
|
||||
<SelectItem value="am" text="AM" />
|
||||
|
|
@ -37,11 +33,9 @@ Use the light variant for light-themed backgrounds by setting `light` to `true`.
|
|||
</TimePickerSelect>
|
||||
</TimePicker>
|
||||
|
||||
## Extra-large size
|
||||
## Large size
|
||||
|
||||
Use the extra-large size for more prominent time pickers by setting `size` to `"xl"`.
|
||||
|
||||
<TimePicker size="xl" labelText="Cron job" placeholder="hh:mm">
|
||||
<TimePicker size="lg" labelText="Cron job" placeholder="hh:mm">
|
||||
<TimePickerSelect value="pm">
|
||||
<SelectItem value="am" text="AM" />
|
||||
<SelectItem value="pm" text="PM" />
|
||||
|
|
@ -54,8 +48,6 @@ Use the extra-large size for more prominent time pickers by setting `size` to `"
|
|||
|
||||
## Small size
|
||||
|
||||
Use the small size for more compact time pickers by setting `size` to `"sm"`.
|
||||
|
||||
<TimePicker size="sm" labelText="Cron job" placeholder="hh:mm">
|
||||
<TimePickerSelect value="pm">
|
||||
<SelectItem value="am" text="AM" />
|
||||
|
|
@ -69,8 +61,6 @@ Use the small size for more compact time pickers by setting `size` to `"sm"`.
|
|||
|
||||
## Invalid state
|
||||
|
||||
Indicate an invalid state with an error message by setting `invalid` to `true` and providing `invalidText`.
|
||||
|
||||
<TimePicker invalid invalidText="A valid value is required" labelText="Cron job" placeholder="hh:mm">
|
||||
<TimePickerSelect value="pm">
|
||||
<SelectItem value="am" text="AM" />
|
||||
|
|
@ -82,9 +72,8 @@ Indicate an invalid state with an error message by setting `invalid` to `true` a
|
|||
</TimePickerSelect>
|
||||
</TimePicker>
|
||||
|
||||
## Disabled state
|
||||
|
||||
Disable the time picker to prevent user interaction by setting `disabled` to `true`.
|
||||
## Disabled state
|
||||
|
||||
<TimePicker labelText="Cron job" placeholder="hh:mm" disabled>
|
||||
<TimePickerSelect value="pm" disabled>
|
||||
|
|
|
|||
|
|
@ -1,32 +1,22 @@
|
|||
---
|
||||
components: ["ToastNotification"]
|
||||
---
|
||||
|
||||
<script>
|
||||
import { ToastNotification } from "carbon-components-svelte";
|
||||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`ToastNotification` displays non-modal, time-based messages that appear at the top of the screen and automatically disappear. It supports various notification types, custom content, and accessibility features.
|
||||
Toasts are non-modal, time-based window elements used to display short messages;
|
||||
they usually appear at the top of the screen and disappear after a few seconds.
|
||||
|
||||
See [detailed usage](https://carbondesignsystem.com/components/notification/usage).
|
||||
See [detailed
|
||||
usage](https://carbondesignsystem.com/components/notification/usage).
|
||||
See also: [InlineNotification](InlineNotification)
|
||||
|
||||
## Default
|
||||
|
||||
Display a basic error notification with title, subtitle, and timestamp by default.
|
||||
## Default (error)
|
||||
|
||||
<ToastNotification title="Error" subtitle="An internal server error occurred." caption="{new Date().toLocaleString()}" />
|
||||
|
||||
## Autoclose
|
||||
|
||||
Specify the `timeout` prop to automatically close the notification after a specified duration (in milliseconds).
|
||||
|
||||
<FileSource src="/framed/ToastNotification/ToastNotificationTimeout" />
|
||||
|
||||
## Prevent default close behavior
|
||||
|
||||
Prevent the default close behavior using `e.preventDefault()` in the `on:close` event handler.
|
||||
`ToastNotification` is a controlled component. Prevent the default close behavior using the `e.preventDefault()` method in the dispatched `on:close` event.
|
||||
|
||||
<ToastNotification title="Error" subtitle="An internal server error occurred." caption="{new Date().toLocaleString()}" on:close={(e) => {
|
||||
e.preventDefault();
|
||||
|
|
@ -35,14 +25,12 @@ Prevent the default close behavior using `e.preventDefault()` in the `on:close`
|
|||
|
||||
## Full width
|
||||
|
||||
Set `fullWidth` to `true` for the notification to span the full width of its container.
|
||||
Set `fullWidth` to `true` for the notification to span the full width of its containing element.
|
||||
|
||||
<ToastNotification fullWidth title="Error" subtitle="An internal server error occurred." caption="{new Date().toLocaleString()}" />
|
||||
|
||||
## Slottable title, subtitle, caption
|
||||
|
||||
Customize the notification content using slots for more flexibility.
|
||||
|
||||
<ToastNotification>
|
||||
<strong slot="title">Error: </strong>
|
||||
<strong slot="subtitle">An internal server error occurred.</strong>
|
||||
|
|
@ -51,7 +39,9 @@ Customize the notification content using slots for more flexibility.
|
|||
|
||||
## Accessible icon descriptions
|
||||
|
||||
Provide custom descriptions for icons to improve accessibility.
|
||||
The status icon and close button icon descriptions appear on cursor hover and are read
|
||||
by assistive technology. Default descriptions are provided in English and can be
|
||||
overridden via `statusIconDescription` and `closeButtonDescription`.
|
||||
|
||||
<ToastNotification
|
||||
title="错误"
|
||||
|
|
@ -62,14 +52,10 @@ Provide custom descriptions for icons to improve accessibility.
|
|||
|
||||
## Hidden close button
|
||||
|
||||
Create a persistent notification by hiding the close button.
|
||||
|
||||
<ToastNotification hideCloseButton kind="warning" title="Scheduled maintenance" subtitle="Maintenance will last 2-4 hours." caption="{new Date().toLocaleString()}" />
|
||||
|
||||
## Notification variants
|
||||
|
||||
The component supports different notification types:
|
||||
|
||||
<ToastNotification kind="error" title="Error" subtitle="An internal server error occurred." caption="{new Date().toLocaleString()}" />
|
||||
<ToastNotification kind="info" title="New updates" subtitle="Restart to get the latest updates." caption="{new Date().toLocaleString()}" />
|
||||
<ToastNotification kind="info-square" title="New updates" subtitle="Restart to get the latest updates." caption="{new Date().toLocaleString()}" />
|
||||
|
|
@ -79,8 +65,6 @@ The component supports different notification types:
|
|||
|
||||
## Low contrast
|
||||
|
||||
Use low contrast variants for less prominent notifications.
|
||||
|
||||
<ToastNotification lowContrast kind="error" title="Error" subtitle="An internal server error occurred." caption="{new Date().toLocaleString()}" />
|
||||
<ToastNotification lowContrast kind="info" title="New updates" subtitle="Restart to get the latest updates." caption="{new Date().toLocaleString()}" />
|
||||
<ToastNotification lowContrast kind="info-square" title="New updates" subtitle="Restart to get the latest updates." caption="{new Date().toLocaleString()}" />
|
||||
|
|
|
|||
|
|
@ -1,79 +1,42 @@
|
|||
---
|
||||
components: ["Toggle", "ToggleSkeleton"]
|
||||
components: ["Toggle"]
|
||||
---
|
||||
|
||||
<script>
|
||||
import { Toggle, ToggleSkeleton } from "carbon-components-svelte";
|
||||
import { Toggle } from "carbon-components-svelte";
|
||||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`Toggle` provides a switch-like control that allows users to turn options on or off. It supports custom labels, different sizes, and various states to match your application's needs.
|
||||
|
||||
## Default
|
||||
|
||||
Display a basic toggle in its untoggled state by default.
|
||||
## Default (untoggled)
|
||||
|
||||
<Toggle labelText="Push notifications" />
|
||||
|
||||
## Toggled
|
||||
|
||||
Set `toggled` to `true` to display the toggle in its on state.
|
||||
|
||||
<Toggle labelText="Push notifications" toggled />
|
||||
|
||||
## Reactive example
|
||||
|
||||
Use two-way binding to control the toggle state programmatically.
|
||||
|
||||
<FileSource src="/framed/Toggle/ToggleReactive" />
|
||||
|
||||
## on:toggle event
|
||||
|
||||
Listen for toggle state changes using the `on:toggle` event.
|
||||
|
||||
<Toggle labelText="Push notifications" on:toggle={e => console.log(e.detail)} />
|
||||
|
||||
## Hidden label text
|
||||
|
||||
Set `hideLabel` to `true` to visually hide the label while maintaining accessibility.
|
||||
Set `hideLabel` to `true` to visually hide the label text. It's recommended to still specify `labelText` for screen reader accessibility.
|
||||
|
||||
<Toggle labelText="Push notifications" hideLabel />
|
||||
|
||||
## Custom labels
|
||||
|
||||
Customize the toggle labels using `labelA` and `labelB` props.
|
||||
|
||||
<Toggle labelText="Push notifications" labelA="No" labelB="Yes" />
|
||||
|
||||
## Slottable labels
|
||||
|
||||
Use slots to customize the toggle labels with additional styling or content.
|
||||
|
||||
<Toggle labelText="Push notifications">
|
||||
<span slot="labelA" style="color: red">No</span>
|
||||
<span slot="labelB" style="color: green">Yes</span>
|
||||
</Toggle>
|
||||
|
||||
## Disabled state
|
||||
|
||||
Set `disabled` to `true` to prevent user interaction.
|
||||
## Disabled
|
||||
|
||||
<Toggle labelText="Push notifications" disabled />
|
||||
|
||||
## Small size
|
||||
|
||||
Use the small size variant by setting `size` to `"sm"`.
|
||||
|
||||
<Toggle size="sm" labelText="Push notifications" />
|
||||
|
||||
## Skeleton
|
||||
|
||||
Display a loading state using the skeleton component.
|
||||
|
||||
<ToggleSkeleton />
|
||||
|
||||
## Skeleton (small)
|
||||
|
||||
Use the small size variant for the skeleton component.
|
||||
|
||||
<ToggleSkeleton size="sm" />
|
||||
|
|
@ -8,11 +8,9 @@ components: ["Tooltip", "TooltipFooter"]
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`Tooltip` displays contextual information when users hover over or focus on an element. It supports various directions, alignments, and interactive content to provide additional context or guidance.
|
||||
|
||||
## Default
|
||||
|
||||
Display a tooltip triggered by the default information icon.
|
||||
By default, the tooltip is triggered by an information icon.
|
||||
|
||||
<Tooltip>
|
||||
<p>
|
||||
|
|
@ -22,8 +20,6 @@ Display a tooltip triggered by the default information icon.
|
|||
|
||||
## With trigger text
|
||||
|
||||
Use custom trigger text instead of the default icon.
|
||||
|
||||
<Tooltip triggerText="Resource list">
|
||||
<p>
|
||||
Resources are provisioned based on your account's organization.
|
||||
|
|
@ -32,14 +28,10 @@ Use custom trigger text instead of the default icon.
|
|||
|
||||
## Reactive example
|
||||
|
||||
Control the tooltip state programmatically.
|
||||
|
||||
<FileSource src="/framed/Tooltip/TooltipReactive" />
|
||||
|
||||
## Directions
|
||||
|
||||
Position the tooltip in different directions using the `direction` prop.
|
||||
|
||||
<Tooltip triggerText="Top" direction="top"><p>Top</p></Tooltip>
|
||||
<Tooltip triggerText="Right" direction="right"><p>Right</p></Tooltip>
|
||||
<Tooltip triggerText="Bottom" direction="bottom"><p>Bottom</p></Tooltip>
|
||||
|
|
@ -47,16 +39,12 @@ Position the tooltip in different directions using the `direction` prop.
|
|||
|
||||
## Alignment
|
||||
|
||||
Align the tooltip content using the `align` prop.
|
||||
|
||||
<Tooltip triggerText="Start" align="start"><p>Start</p></Tooltip>
|
||||
<Tooltip triggerText="End" align="end"><p>End</p></Tooltip>
|
||||
<Tooltip triggerText="Center" align="center"><p>Center</p></Tooltip>
|
||||
|
||||
## Interactive
|
||||
|
||||
Add interactive elements like links and buttons using `TooltipFooter`.
|
||||
|
||||
<Tooltip triggerText="Resource list">
|
||||
<p>
|
||||
Resources are provisioned based on your account's organization.
|
||||
|
|
@ -64,13 +52,11 @@ Add interactive elements like links and buttons using `TooltipFooter`.
|
|||
<TooltipFooter selectorPrimaryFocus="#d">
|
||||
<Link href="/">Learn more</Link>
|
||||
<Button id="d" size="small">Manage</Button>
|
||||
</TooltipFooter>
|
||||
</TooltipFooter>
|
||||
</Tooltip>
|
||||
|
||||
## Custom icon (component)
|
||||
|
||||
Use a custom icon component with the `icon` prop.
|
||||
|
||||
<Tooltip triggerText="Resource list" icon={Catalog}>
|
||||
<p>
|
||||
Resources are provisioned based on your account's organization.
|
||||
|
|
@ -79,8 +65,6 @@ Use a custom icon component with the `icon` prop.
|
|||
|
||||
## Custom icon (slot)
|
||||
|
||||
Customize the icon using the `icon` slot for more flexibility.
|
||||
|
||||
<Tooltip triggerText="Resource list">
|
||||
<div slot="icon" style="width: 1rem; height: 1rem; outline: 1px solid red;"></div>
|
||||
<p>
|
||||
|
|
@ -90,8 +74,6 @@ Customize the icon using the `icon` slot for more flexibility.
|
|||
|
||||
## Hidden icon
|
||||
|
||||
Hide the icon while keeping the tooltip functionality using `hideIcon`.
|
||||
|
||||
<Tooltip hideIcon triggerText="Resource list">
|
||||
<p>
|
||||
Resources are provisioned based on your account's organization.
|
||||
|
|
|
|||
|
|
@ -3,19 +3,17 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`TooltipDefinition` provides inline definitions for terms or concepts. It displays a tooltip when users hover over or focus on the defined term, making it ideal for providing additional context without cluttering the interface.
|
||||
|
||||
## Default
|
||||
|
||||
Display a basic definition tooltip with the default bottom-center alignment.
|
||||
|
||||
<TooltipDefinition tooltipText="IBM Corporate Headquarters is based in Armonk, New York.">
|
||||
Armonk
|
||||
</TooltipDefinition>
|
||||
|
||||
## Custom tooltip direction and alignment
|
||||
|
||||
Customize the tooltip position using the `direction` and `align` props. The default direction is `"bottom"` and alignment is `"center"`.
|
||||
Customize the tooltip menu direction and alignment through the `direction` and `align` props.
|
||||
|
||||
By default, `direction` is `"bottom"` and `align` is `"center"`.
|
||||
|
||||
<TooltipDefinition direction="top" align="start" tooltipText="IBM Corporate Headquarters is based in Armonk, New York.">
|
||||
Armonk
|
||||
|
|
@ -23,8 +21,6 @@ Customize the tooltip position using the `direction` and `align` props. The defa
|
|||
|
||||
## Custom tooltip slot
|
||||
|
||||
Use the `tooltip` slot to customize the tooltip content with additional styling or structure.
|
||||
|
||||
<TooltipDefinition>
|
||||
Armonk
|
||||
<span slot="tooltip" style="color: red">
|
||||
|
|
|
|||
|
|
@ -5,18 +5,12 @@
|
|||
import Preview from "../../components/Preview.svelte";
|
||||
</script>
|
||||
|
||||
`TooltipIcon` displays contextual information when users hover over or focus on an icon. It's ideal for providing additional context about icons or actions in your interface.
|
||||
|
||||
## Default
|
||||
|
||||
Display a tooltip with the default bottom-center alignment.
|
||||
## Default ("bottom" direction, "center" aligned)
|
||||
|
||||
<TooltipIcon tooltipText="Carbon is an open source design system by IBM." icon={Carbon} />
|
||||
|
||||
## Directions
|
||||
|
||||
Position the tooltip in different directions and alignments using the `direction` and `align` props.
|
||||
|
||||
<TooltipIcon tooltipText="Top start" direction="top" align="start" icon={Filter} />
|
||||
<TooltipIcon tooltipText="Right end" direction="right" align="end" icon={Filter} />
|
||||
<TooltipIcon tooltipText="Bottom start" direction="bottom" align="start" icon={Filter} />
|
||||
|
|
@ -24,14 +18,12 @@ Position the tooltip in different directions and alignments using the `direction
|
|||
|
||||
## Custom tooltip text
|
||||
|
||||
Use the `tooltipText` slot to customize the tooltip content with additional styling.
|
||||
Use the "text" slot to customize the tooltip text.
|
||||
|
||||
<TooltipIcon icon={Carbon}>
|
||||
<span slot="tooltipText" style="color: red">Carbon is an open source design system by IBM.</span>
|
||||
</TooltipIcon>
|
||||
|
||||
## Disabled state
|
||||
|
||||
Set `disabled` to `true` to prevent user interaction with the tooltip.
|
||||
## Disabled
|
||||
|
||||
<TooltipIcon disabled tooltipText="Carbon is an open source design system by IBM." icon={Carbon} />
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue