diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md index 093d3222..939d9c24 100644 --- a/COMPONENT_INDEX.md +++ b/COMPONENT_INDEX.md @@ -1,6 +1,6 @@ # Component Index -> 167 components exported from carbon-components-svelte@0.36.0. +> 168 components exported from carbon-components-svelte@0.36.0. ## Components @@ -99,6 +99,7 @@ - [`PaginationSkeleton`](#paginationskeleton) - [`PasswordInput`](#passwordinput) - [`Popover`](#popover) +- [`ProgressBar`](#progressbar) - [`ProgressIndicator`](#progressindicator) - [`ProgressIndicatorSkeleton`](#progressindicatorskeleton) - [`ProgressStep`](#progressstep) @@ -2816,6 +2817,28 @@ None. | :------------ | :--------- | :----- | | click:outside | dispatched | -- | +## `ProgressBar` + +### Props + +| Prop name | Kind | Reactive | Type | Default value | Description | +| :--------- | :--------------- | :------- | :------------------- | ------------------ | --------------------------------------------- | +| value | let | No | number | -- | Specify the current value | +| max | let | No | number | 100 | Specify the maximum value | +| labelText | let | No | string | "" | Specify the label text | +| hideLabel | let | No | boolean | false | Set to `true` to visually hide the label text | +| helperText | let | No | string | "" | Specify the helper text | + +### Slots + +| Slot name | Default | Props | Fallback | +| :-------- | :------ | :---- | :----------------------- | +| labelText | No | -- | {labelText} | + +### Events + +None. + ## `ProgressIndicator` ### Props diff --git a/docs/package.json b/docs/package.json index e5d21215..8b0bf24b 100644 --- a/docs/package.json +++ b/docs/package.json @@ -11,7 +11,7 @@ "devDependencies": { "@sveltech/routify": "^1.9.9", "autoprefixer": "^10.2.3", - "carbon-components": "10.36.0", + "carbon-components": "10.37.0", "carbon-components-svelte": "../", "mdsvex": "^0.8.8", "npm-run-all": "^4.1.5", diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json index ef039e51..d145ab3b 100644 --- a/docs/src/COMPONENT_API.json +++ b/docs/src/COMPONENT_API.json @@ -1,5 +1,5 @@ { - "total": 167, + "total": 168, "components": [ { "moduleName": "Accordion", @@ -7302,6 +7302,72 @@ "typedefs": [], "rest_props": { "type": "Element", "name": "div" } }, + { + "moduleName": "ProgressBar", + "filePath": "src/ProgressBar/ProgressBar.svelte", + "props": [ + { + "name": "value", + "kind": "let", + "description": "Specify the current value", + "type": "number", + "isFunction": false, + "constant": false, + "reactive": false + }, + { + "name": "max", + "kind": "let", + "description": "Specify the maximum value", + "type": "number", + "value": "100", + "isFunction": false, + "constant": false, + "reactive": false + }, + { + "name": "labelText", + "kind": "let", + "description": "Specify the label text", + "type": "string", + "value": "\"\"", + "isFunction": false, + "constant": false, + "reactive": false + }, + { + "name": "hideLabel", + "kind": "let", + "description": "Set to `true` to visually hide the label text", + "type": "boolean", + "value": "false", + "isFunction": false, + "constant": false, + "reactive": false + }, + { + "name": "helperText", + "kind": "let", + "description": "Specify the helper text", + "type": "string", + "value": "\"\"", + "isFunction": false, + "constant": false, + "reactive": false + } + ], + "slots": [ + { + "name": "labelText", + "default": false, + "fallback": "{labelText}", + "slot_props": "{}" + } + ], + "events": [], + "typedefs": [], + "rest_props": { "type": "Element", "name": "div" } + }, { "moduleName": "ProgressIndicator", "filePath": "src/ProgressIndicator/ProgressIndicator.svelte", diff --git a/docs/src/pages/_layout.svelte b/docs/src/pages/_layout.svelte index e2278dac..ddc4aca6 100644 --- a/docs/src/pages/_layout.svelte +++ b/docs/src/pages/_layout.svelte @@ -20,7 +20,7 @@ import Footer from "../components/Footer.svelte"; const deprecated = ["ToggleSmall", "Icon"]; - const new_components = ["Popover", "ContextMenu"]; + const new_components = ["ProgressBar"]; let isOpen = false; let isSideNavOpen = true; diff --git a/docs/src/pages/components/ProgressBar.svx b/docs/src/pages/components/ProgressBar.svx new file mode 100644 index 00000000..b81cf599 --- /dev/null +++ b/docs/src/pages/components/ProgressBar.svx @@ -0,0 +1,24 @@ + + +### Default + +Without a specified `value` prop, the progress bar is indeterminate. + + + +### Percentage + + + +### Custom max value + +The default `max` value is `100`. + + + +### Hidden label + + \ No newline at end of file diff --git a/docs/src/pages/framed/ProgressBar/ProgressBarUx.svelte b/docs/src/pages/framed/ProgressBar/ProgressBarUx.svelte new file mode 100644 index 00000000..83dd89b6 --- /dev/null +++ b/docs/src/pages/framed/ProgressBar/ProgressBarUx.svelte @@ -0,0 +1,36 @@ + + + diff --git a/docs/yarn.lock b/docs/yarn.lock index 187a373a..9832193e 100644 --- a/docs/yarn.lock +++ b/docs/yarn.lock @@ -837,16 +837,16 @@ caniuse-lite@^1.0.30001173, caniuse-lite@^1.0.30001178: integrity sha512-n8JVqXuZMVSPKiPiypjFtDTXc4jWIdjxull0f92WLo7e1MSi3uJ3NvveakSh/aCl1QKFAvIz3vIj0v+0K+FrXw== carbon-components-svelte@../: - version "0.35.0" + version "0.36.0" dependencies: carbon-icons-svelte "^10.27.0" clipboard-copy "3.2.0" flatpickr "4.6.9" -carbon-components@10.36.0: - version "10.36.0" - resolved "https://registry.yarnpkg.com/carbon-components/-/carbon-components-10.36.0.tgz#ce523b19df3a404e379113dafbbe0219bb22b17f" - integrity sha512-k+UR+Whz/qXbev2RT9JjV+QbkSKcHrLNF25bEpr3KZHmpCGhwGz5mVyv0ohZ4B6rKkpuvlgYfLsANL0yQX77zA== +carbon-components@10.37.0: + version "10.37.0" + resolved "https://registry.yarnpkg.com/carbon-components/-/carbon-components-10.37.0.tgz#bc53138151ea58e79f5b249b1ec5be8ae2c0a7e4" + integrity sha512-LHReeqzzieP/q/xAHfKJNWLdWhOkr7+DIVZkrQGPf6kZYj5H8tb1KYKOIhasvCNRxJ2es8QJXuH7XW0JoLDfdQ== dependencies: "@carbon/telemetry" "0.0.0-alpha.6" flatpickr "4.6.1" diff --git a/package.json b/package.json index 976a60a7..e45fb2f2 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,7 @@ "@rollup/plugin-node-resolve": "^11.1.1", "@tsconfig/svelte": "^1.0.10", "autoprefixer": "^10.2.4", - "carbon-components": "10.36.0", + "carbon-components": "10.37.0", "gh-pages": "^3.1.0", "husky": "^4.3.8", "lint-staged": "^10.5.3", diff --git a/src/DataTable/ToolbarSearch.svelte b/src/DataTable/ToolbarSearch.svelte index 76fd2d77..fa9daa21 100644 --- a/src/DataTable/ToolbarSearch.svelte +++ b/src/DataTable/ToolbarSearch.svelte @@ -47,7 +47,6 @@
- + - + + /** + * Specify the current value + * @type {number} + */ + export let value = undefined; + + /** Specify the maximum value */ + export let max = 100; + + /** Specify the label text */ + export let labelText = ""; + + /** Set to `true` to visually hide the label text */ + export let hideLabel = false; + + /** Specify the helper text */ + export let helperText = ""; + + let id = "ccs-" + Math.random().toString(36); + let helperId = "ccs-" + Math.random().toString(36); + + $: indeterminate = value === undefined; + $: capped = value > max ? max : value < 0 ? 0 : value; + + +
+ +
+
+
+ {#if helperText} +
+ {helperText} +
+ {/if} +
diff --git a/src/ProgressBar/index.js b/src/ProgressBar/index.js new file mode 100644 index 00000000..767154cd --- /dev/null +++ b/src/ProgressBar/index.js @@ -0,0 +1 @@ +export { default as ProgressBar } from "./ProgressBar.svelte"; diff --git a/src/TextInput/TextInput.svelte b/src/TextInput/TextInput.svelte index 04371fe1..e41b3733 100644 --- a/src/TextInput/TextInput.svelte +++ b/src/TextInput/TextInput.svelte @@ -83,7 +83,7 @@ on:mouseleave > {#if inline} -
+
{#if labelText}