mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-16 10:51:06 +00:00
**carbon-components-svelte has unstable styles and interactions during this pre-release phase. See #1872 for details.**
Breaking changes
- Overall, this is a major style change the will impact the appearance and features of many components. Use caution when upgrading and test your applications.
Components
- Button has new prop values for size and kind
- Theme follows v11 conventions: g80 theme isn't supported, toggled themes adjust data-carbon-theme attribute in <html> tag (for now, tokens use bx prefix, but that may change)
- Tabs has a contained prop instead of type, and a new mobile appearance (scrolling tabs)
- ContentSwitcher size prop no longer supports size="xl"; md is the new default
- MultiSelect no longer supports xl size
- OverflowMenu no longer supports xl size
- Search no longer supports xl size
- TreeView no longer supports compact size
- UIShell has a new light theme
CSS
- Several class names have been changed due to the v11 overhaul. If you're targeting or overriding component classes, be sure to test your code
- Many tokens and CSS variables have been renamed. Details: https://carbondesignsystem.com/migrating/guide/develop
- Themes are applied to the <html> element as data-carbon-theme="g10" instead of theme="g10"
- The g80 theme no longer exists
General
- Codebase uses npm instead of yarn
--- Commit notes
* chore: depend on @carbon/styles instead of carbon-components
See upgrade guide here: https://carbondesignsystem.com/migrating/guide/develop
* chore: use v11 styles for docs
* chore: stick to `bx` instead of `cds` class prefix
* chore: migrate layout spacing to v11
See [@carbon/layout](https://github.com/carbon-design-system/carbon/blob/main/docs/migration/v11.md#carbonlayout) migration guide:
$layout-01 Removed, use $spacing-05 instead
$layout-02 Removed, use $spacing-06 instead
$layout-03 Removed, use $spacing-07 instead
$layout-04 Removed, use $spacing-09 instead
$layout-05 Removed, use $spacing-10 instead
$layout-06 Removed, use $spacing-12 instead
$layout-07 Removed, use $spacing-13 instead
* chore: migrate type tokens to v11
See https://github.com/carbon-design-system/carbon/blob/main/docs/migration/v11.md#type-tokens
* chore: keep flex-grid instead of css grid for the moment
Upgrading to css-grid should be separate.
* chore: v11 Tabs
In v11 [Tabs](https://carbondesignsystem.com/migrating/guide/design/#tabs-breaking) received some additional modifiers. In this commit we only want to make sure that the Svelte v10 tabs still work using v11 styles. This probably needs additional testing.
* chore: use @ibm/plex fonts
* chore: v11 Button
* dependency: @carbon/styles update
* chore: v11 ComboBox
Size `xl` changed to `lg`. For better compatibility with existing codebases size `xl` is still supported.
* chore: v11 ContentSwitcher
For better compatibility with existing code bases size `xl` is still supported.
* chore: remove legacy v10 css files
Note that further work is needed here in order to make theming work again.
Also documentation needs updating.
* chore: v11 DatePicker
For better compatibility with existing codebases size xl is still supported.
* chore: v11 Dropdown
For better compatibility with existing codebases size xl is still supported.
* chore: v11 ExpandableTile
Note that state labels `tileCollapsedLabel` and `tileExpandedLabel` are no longer supported.
* chore: v11 FileUploader
For better compatibility with existing codebases sizes `field` and `small` are still supported. Note that flagship implementation does the same thing.
* chore: v11 Toggle
This removes legacy `ToggleSkeleton`.
* chore: v11 MultiSelect
Size `xl` changed to `lg`.
* chore: v11 NumberInput
For better compatibility with existing codebases size `xl` is still supported.
* chore: v11 OverflowMenu
Size `xl` changed to `lg`. For better compatibility with existing codebases size `xl` is still supported.
* chore: v11 PasswordInput
Size `xl` changed to `lg`. For better compatibility with existing codebases size `xl` is still supported.
* chore: v11 Search
* chore: v11 Select
Size `xl` changed to `lg`. For better compatibility with existing codebases size `xl` is still supported.
* chore: v11 AspectRatio
The `bx--aspect-ratio--object` class is gone and needs to be replaced manually.
* chore: v11 TextArea
`cols` no longer has a defaults to 50 but remains at 100% width by default.
* chore: v11 TextInput
Size `xl` changed to `lg`. For better compatibility with existing codebases size `xl` is still supported.
* chore: v11 TimePicker
Size `xl` changed to `lg`. For better compatibility with existing codebases size `xl` is still supported.
* chore: v11 TreeView
Size `compact` changed to `xs`. For better compatibility with existing codebases size `compact` is still supported.
* chore: remove Truncate since it does not exist in Carbon v11
* chore: v11 UIShell
* chore: v11 Accordion
Size `xl` changed to `lg`. For better compatibility with existing codebases size `xl` is still supported.
* tmp: v11 PopoverContent
* Revert "chore: remove Truncate since it does not exist in Carbon v11"
This reverts commit 5833536199
.
* chore: use truncate mixins
* docs: add truncate mixins
* chore: use `cds` class prefix in v11 styles
* build: switch to npm
* chore: set up all component styles, fonts, and themes
- Adapt documentation to new styles
* chore: add individual theme css
* feat: migrate Theme component to v11
- remove g80 theme option everywhere
- utilize new `data-carbon-theme` attribute when applying theme
- use cds instead of bx in places
* chore: use bx css prefixes for now
* chore: resolve peerDependencies
- Leaving out latest prettier for now
- Ignoring Sveld warnings for now
* chore: fix type errors and tests
---------
Co-authored-by: Gregor Wassmann <gregor.wassmann@gmail.com>
265 lines
7.6 KiB
Svelte
265 lines
7.6 KiB
Svelte
<script>
|
|
/**
|
|
* Set the size of the input
|
|
* @type {"sm" | "lg"}
|
|
*/
|
|
export let size = undefined;
|
|
|
|
/**
|
|
* Specify the input value
|
|
* @type {number | string}
|
|
*/
|
|
export let value = "";
|
|
|
|
/**
|
|
* Set to `"text"` to toggle the password visibility
|
|
* @type {"text" | "password"}
|
|
*/
|
|
export let type = "password";
|
|
|
|
/** Specify the placeholder text */
|
|
export let placeholder = "";
|
|
|
|
/** Specify the hide password label text */
|
|
export let hidePasswordLabel = "Hide password";
|
|
|
|
/** Specify the show password label text */
|
|
export let showPasswordLabel = "Show password";
|
|
|
|
/**
|
|
* Set the alignment of the tooltip relative to the icon
|
|
* @type {"start" | "center" | "end"}
|
|
*/
|
|
export let tooltipAlignment = "center";
|
|
|
|
/**
|
|
* Set the position of the tooltip relative to the icon
|
|
* @type {"top" | "right" | "bottom" | "left"}
|
|
*/
|
|
export let tooltipPosition = "bottom";
|
|
|
|
/** Set to `true` to enable the light variant */
|
|
export let light = false;
|
|
|
|
/** Set to `true` to disable the input */
|
|
export let disabled = false;
|
|
|
|
/** Specify the helper text */
|
|
export let helperText = "";
|
|
|
|
/** Specify the label text */
|
|
export let labelText = "";
|
|
|
|
/** Set to `true` to visually hide the label text */
|
|
export let hideLabel = false;
|
|
|
|
/** Set to `true` to indicate an invalid state */
|
|
export let invalid = false;
|
|
|
|
/** Specify the text for the invalid state */
|
|
export let invalidText = "";
|
|
|
|
/** Set to `true` to indicate an warning state */
|
|
export let warn = false;
|
|
|
|
/** Specify the warning state text */
|
|
export let warnText = "";
|
|
|
|
/** Set to `true` to use inline version */
|
|
export let inline = false;
|
|
|
|
/** Set an id for the input element */
|
|
export let id = "ccs-" + Math.random().toString(36);
|
|
|
|
/**
|
|
* Specify a name attribute for the input
|
|
* @type {string}
|
|
*/
|
|
export let name = undefined;
|
|
|
|
/** Obtain a reference to the input HTML element */
|
|
export let ref = null;
|
|
|
|
import { getContext } from "svelte";
|
|
import WarningFilled from "../icons/WarningFilled.svelte";
|
|
import WarningAltFilled from "../icons/WarningAltFilled.svelte";
|
|
import View from "../icons/View.svelte";
|
|
import ViewOff from "../icons/ViewOff.svelte";
|
|
|
|
const ctx = getContext("Form");
|
|
|
|
$: isFluid = !!ctx && ctx.isFluid;
|
|
$: helperId = `helper-${id}`;
|
|
$: errorId = `error-${id}`;
|
|
$: warnId = `warn-${id}`;
|
|
</script>
|
|
|
|
<!-- svelte-ignore a11y-mouse-events-have-key-events -->
|
|
<!-- svelte-ignore a11y-click-events-have-key-events -->
|
|
<!-- svelte-ignore a11y-no-static-element-interactions -->
|
|
<div
|
|
class:bx--form-item="{true}"
|
|
class:bx--text-input-wrapper="{true}"
|
|
class:bx--password-input-wrapper="{!isFluid}"
|
|
class:bx--text-input-wrapper--light="{light}"
|
|
class:bx--text-input-wrapper--inline="{inline}"
|
|
on:click
|
|
on:mouseover
|
|
on:mouseenter
|
|
on:mouseleave
|
|
>
|
|
{#if inline}
|
|
<label
|
|
for="{id}"
|
|
class:bx--label="{true}"
|
|
class:bx--visually-hidden="{hideLabel}"
|
|
class:bx--label--disabled="{disabled}"
|
|
class:bx--label--inline="{inline}"
|
|
class:bx--label--inline--sm="{inline && size === 'sm'}"
|
|
class:bx--label--inline--lg="{inline && (size === 'lg' || size === 'xl')}"
|
|
>
|
|
<slot name="labelText">
|
|
{labelText}
|
|
</slot>
|
|
</label>
|
|
{#if !isFluid && helperText}
|
|
<div
|
|
id="{helperId}"
|
|
class:bx--form__helper-text="{true}"
|
|
class:bx--form__helper-text--disabled="{disabled}"
|
|
class:bx--form__helper-text--inline="{inline}"
|
|
>
|
|
{helperText}
|
|
</div>
|
|
{/if}
|
|
{/if}
|
|
{#if !inline && (labelText || $$slots.labelText)}
|
|
<label
|
|
for="{id}"
|
|
class:bx--label="{true}"
|
|
class:bx--visually-hidden="{hideLabel}"
|
|
class:bx--label--disabled="{disabled}"
|
|
class:bx--label--inline="{inline}"
|
|
class:bx--label--inline--sm="{inline && size === 'sm'}"
|
|
class:bx--label--inline--lg="{inline && (size === 'lg' || size === 'xl')}"
|
|
>
|
|
<slot name="labelText">
|
|
{labelText}
|
|
</slot>
|
|
</label>
|
|
{/if}
|
|
<div
|
|
class:bx--text-input__field-outer-wrapper="{true}"
|
|
class:bx--text-input__field-outer-wrapper--inline="{inline}"
|
|
>
|
|
<div
|
|
class:bx--text-input__field-wrapper="{true}"
|
|
class:bx--text-input__field-wrapper--warning="{warn}"
|
|
data-invalid="{invalid || undefined}"
|
|
>
|
|
{#if invalid}
|
|
<WarningFilled class="bx--text-input__invalid-icon" />
|
|
{/if}
|
|
{#if !invalid && warn}
|
|
<WarningAltFilled
|
|
class="bx--text-input__invalid-icon
|
|
bx--text-input__invalid-icon--warning"
|
|
/>
|
|
{/if}
|
|
<input
|
|
bind:this="{ref}"
|
|
data-invalid="{invalid || undefined}"
|
|
aria-invalid="{invalid || undefined}"
|
|
aria-describedby="{invalid
|
|
? errorId
|
|
: warn
|
|
? warnId
|
|
: helperText
|
|
? helperId
|
|
: undefined}"
|
|
id="{id}"
|
|
name="{name}"
|
|
placeholder="{placeholder}"
|
|
type="{type}"
|
|
value="{value ?? ''}"
|
|
disabled="{disabled}"
|
|
class:bx--text-input="{true}"
|
|
class:bx--password-input="{true}"
|
|
class:bx--text-input--light="{light}"
|
|
class:bx--text-input--invalid="{invalid}"
|
|
class:bx--text-input--warning="{warn}"
|
|
class:bx--text-input--sm="{size === 'sm'}"
|
|
class:bx--text-input--lg="{size === 'lg' || size === 'xl'}"
|
|
{...$$restProps}
|
|
on:change
|
|
on:input
|
|
on:input="{({ target }) => {
|
|
value = target.value;
|
|
}}"
|
|
on:keydown
|
|
on:keyup
|
|
on:focus
|
|
on:blur
|
|
on:paste
|
|
/>
|
|
{#if isFluid && invalid}
|
|
<hr class="bx--text-input__divider" />
|
|
<div class="bx--form-requirement" id="{errorId}">
|
|
{invalidText}
|
|
</div>
|
|
{/if}
|
|
{#if !(isFluid && invalid)}
|
|
<button
|
|
type="button"
|
|
disabled="{disabled}"
|
|
class:bx--text-input--password__visibility__toggle="{true}"
|
|
class:bx--btn="{true}"
|
|
class:bx--btn--icon-only="{true}"
|
|
class:bx--btn--disabled="{disabled}"
|
|
class:bx--tooltip__trigger="{true}"
|
|
class:bx--tooltip--a11y="{true}"
|
|
class:bx--tooltip--top="{tooltipPosition === 'top'}"
|
|
class:bx--tooltip--right="{tooltipPosition === 'right'}"
|
|
class:bx--tooltip--bottom="{tooltipPosition === 'bottom'}"
|
|
class:bx--tooltip--left="{tooltipPosition === 'left'}"
|
|
class:bx--tooltip--align-start="{tooltipAlignment === 'start'}"
|
|
class:bx--tooltip--align-center="{tooltipAlignment === 'center'}"
|
|
class:bx--tooltip--align-end="{tooltipAlignment === 'end'}"
|
|
on:click="{() => {
|
|
type = type === 'password' ? 'text' : 'password';
|
|
}}"
|
|
>
|
|
{#if !disabled}
|
|
<span class:bx--assistive-text="{true}">
|
|
{#if type === "text"}
|
|
{hidePasswordLabel}
|
|
{:else}{showPasswordLabel}{/if}
|
|
</span>
|
|
{/if}
|
|
{#if type === "text"}
|
|
<ViewOff class="bx--icon-visibility-off" />
|
|
{:else}
|
|
<View class="bx--icon-visibility-on" />
|
|
{/if}
|
|
</button>
|
|
{/if}
|
|
</div>
|
|
{#if !isFluid && invalid}
|
|
<div class:bx--form-requirement="{true}" id="{errorId}">
|
|
{invalidText}
|
|
</div>
|
|
{/if}
|
|
{#if !invalid && !warn && !isFluid && !inline && helperText}
|
|
<div
|
|
class:bx--form__helper-text="{true}"
|
|
class:bx--form__helper-text--disabled="{disabled}"
|
|
class:bx--form__helper-text--inline="{inline}"
|
|
>
|
|
{helperText}
|
|
</div>
|
|
{/if}
|
|
{#if !isFluid && !invalid && warn}
|
|
<div class:bx--form-requirement="{true}" id="{warnId}">{warnText}</div>
|
|
{/if}
|
|
</div>
|
|
</div>
|