carbon-components-svelte/src/Search/Search.svelte
Eric Liu 6bf72d4602
fix(types): loosen icon prop type to any (#2095)
Fixes https://github.com/carbon-design-system/carbon-icons-svelte/issues/207

`carbon-icons-svelte@13` and `carbon-pictograms-svelte@13` now  
only support TypeScript for Svelte 4/5.

The new `Component` type is incompatible with the `icon` prop in  
`carbon-components-svelte`, causing a type error with Svelte 5, as  
`typeof SvelteComponent` doesn't match the new `Component` type.

Since `Component` isn't available in Svelte 3/4, this PR changes  
the `icon` prop type to `any` for compatibility across Svelte 3, 4, and 5.
2025-02-02 19:49:53 -08:00

173 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" | "lg" | "xl"}
*/
export let size = "xl";
/** 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 {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>
<!-- svelte-ignore a11y-autofocus -->
{#if skeleton}
<SearchSkeleton
{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--lg={size === "lg"}
class:bx--search--xl={size === "xl"}
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}
{disabled}
{id}
{placeholder}
{...$$restProps}
on:change
on:input
on:focus
on:focus={() => {
if (expandable) expanded = true;
}}
on:blur
on:blur={() => {
if (expanded && (value === "" || value == null)) {
expanded = false;
}
}}
on:keydown
on:keydown={({ key }) => {
if (key === "Escape") {
value = "";
dispatch("clear");
}
}}
on:keyup
on:paste
/>
<button
type="button"
aria-label={closeButtonLabelText}
{disabled}
class:bx--search-close={true}
class:bx--search-close--hidden={value === "" || value == null}
on:click
on:click={() => {
value = "";
ref.focus();
dispatch("clear");
}}
>
<svelte:component this={Close} size={size === "xl" ? 20 : 16} />
</button>
</div>
{/if}