mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-18 11:36:36 +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>
172 lines
4.2 KiB
Svelte
172 lines
4.2 KiB
Svelte
<script>
|
|
/**
|
|
* @event {null} expand
|
|
* @event {null} collapse
|
|
* @restProps {input}
|
|
*/
|
|
|
|
/**
|
|
* Specify the value of the search input
|
|
* @type {any}
|
|
*/
|
|
export let value = "";
|
|
|
|
/**
|
|
* Specify the size of the search input
|
|
* @type {"sm" | "md" | "lg"}
|
|
*/
|
|
export let size = "md";
|
|
|
|
/** Specify the class name passed to the outer div element */
|
|
export let searchClass = "";
|
|
|
|
/** Set to `true` to display the skeleton state */
|
|
export let skeleton = false;
|
|
|
|
/** Set to `true` to enable the light variant */
|
|
export let light = false;
|
|
|
|
/** Set to `true` to disable the search input */
|
|
export let disabled = false;
|
|
|
|
/** Set to `true` to enable the expandable variant */
|
|
export let expandable = false;
|
|
|
|
/** Set to `true to expand the search input */
|
|
export let expanded = false;
|
|
|
|
/** Specify the `placeholder` attribute of the search input */
|
|
export let placeholder = "Search...";
|
|
|
|
/**
|
|
* Specify the `autocomplete` attribute
|
|
* @type {"on" | "off"}
|
|
*/
|
|
export let autocomplete = "off";
|
|
|
|
/** Set to `true` to auto focus the search element */
|
|
export let autofocus = false;
|
|
|
|
/** Specify the close button label text */
|
|
export let closeButtonLabelText = "Clear search input";
|
|
|
|
/** Specify the label text */
|
|
export let labelText = "";
|
|
|
|
/**
|
|
* Specify the icon to render.
|
|
* Defaults to `<Search />`
|
|
* @type {typeof import("svelte").SvelteComponent<any>}
|
|
*/
|
|
export let icon = IconSearch;
|
|
|
|
/** Set an id for the input element */
|
|
export let id = "ccs-" + Math.random().toString(36);
|
|
|
|
/** Obtain a reference to the input HTML element */
|
|
export let ref = null;
|
|
|
|
import { createEventDispatcher } from "svelte";
|
|
import Close from "../icons/Close.svelte";
|
|
import IconSearch from "../icons/IconSearch.svelte";
|
|
import SearchSkeleton from "./SearchSkeleton.svelte";
|
|
|
|
const dispatch = createEventDispatcher();
|
|
|
|
let searchRef = null;
|
|
|
|
$: if (expanded && ref) ref.focus();
|
|
$: dispatch(expanded ? "expand" : "collapse");
|
|
</script>
|
|
|
|
{#if skeleton}
|
|
<SearchSkeleton
|
|
size="{size}"
|
|
{...$$restProps}
|
|
on:click
|
|
on:mouseover
|
|
on:mouseenter
|
|
on:mouseleave
|
|
/>
|
|
{:else}
|
|
<div
|
|
role="search"
|
|
aria-labelledby="{id}-search"
|
|
class:bx--search="{true}"
|
|
class:bx--search--light="{light}"
|
|
class:bx--search--disabled="{disabled}"
|
|
class:bx--search--sm="{size === 'sm'}"
|
|
class:bx--search--md="{size === 'md'}"
|
|
class:bx--search--lg="{size === 'lg'}"
|
|
class:bx--search--expandable="{expandable}"
|
|
class:bx--search--expanded="{expanded}"
|
|
class="{searchClass}"
|
|
>
|
|
<!-- svelte-ignore a11y-click-events-have-key-events -->
|
|
<!-- svelte-ignore a11y-no-static-element-interactions -->
|
|
<div
|
|
bind:this="{searchRef}"
|
|
class:bx--search-magnifier="{true}"
|
|
on:click="{() => {
|
|
if (expandable) expanded = true;
|
|
}}"
|
|
>
|
|
<svelte:component this="{icon}" class="bx--search-magnifier-icon" />
|
|
</div>
|
|
<label id="{id}-search" for="{id}" class:bx--label="{true}">
|
|
<slot name="labelText">
|
|
{labelText}
|
|
</slot>
|
|
</label>
|
|
<!-- svelte-ignore a11y-autofocus -->
|
|
<input
|
|
bind:this="{ref}"
|
|
bind:value
|
|
type="text"
|
|
role="searchbox"
|
|
class:bx--search-input="{true}"
|
|
autofocus="{autofocus === true ? true : undefined}"
|
|
autocomplete="{autocomplete}"
|
|
disabled="{disabled}"
|
|
id="{id}"
|
|
placeholder="{placeholder}"
|
|
{...$$restProps}
|
|
on:change
|
|
on:input
|
|
on:focus
|
|
on:focus="{() => {
|
|
if (expandable) expanded = true;
|
|
}}"
|
|
on:blur
|
|
on:blur="{() => {
|
|
if (expanded && value.trim().length === 0) {
|
|
expanded = false;
|
|
}
|
|
}}"
|
|
on:keydown
|
|
on:keydown="{({ key }) => {
|
|
if (key === 'Escape') {
|
|
value = '';
|
|
dispatch('clear');
|
|
}
|
|
}}"
|
|
on:keyup
|
|
on:paste
|
|
/>
|
|
<button
|
|
type="button"
|
|
aria-label="{closeButtonLabelText}"
|
|
disabled="{disabled}"
|
|
class:bx--search-close="{true}"
|
|
class:bx--search-close--hidden="{value === ''}"
|
|
on:click
|
|
on:click="{() => {
|
|
value = '';
|
|
ref.focus();
|
|
dispatch('clear');
|
|
}}"
|
|
>
|
|
<Close />
|
|
</button>
|
|
</div>
|
|
{/if}
|