svelte search

pesquisa esbelta

Componente de pesquisa Svelte acessível e personalizável.

Este componente de pesquisa é composto por form semântica e elementos input .

Veja svelte-typeahead para um componente de pesquisa com resultados suspensos.

Experimente no Svelte REPL.

---

Instalação

 # npm
npm i svelte-search

# pnpm
pnpm i svelte-search

# Yarn
yarn add svelte-search

# Bun
bun add svelte-search

Estilo

Este componente não tem estilo por design. Direcione o componente usando o seletor [data-svelte-search] .

 : global ([ data-svelte-search ] input ) {
  width : 100 % ;
  font-size : 1 rem ;
  padding : 0.5 rem ;
  margin : 0.5 rem 0 ;
  border : 1 px solid # e0e0e0 ;
  border-radius : 0.25 rem ;
}

Uso

Ligação bidirecional

< script >
  import Search from " svelte-search " ;

  let value = " " ;
</ script >

< Search bind:value />

{ #if value }
  < button on:click ={() => ( value = " " )}>Clear "{ value }"</ button >
{ /if }

em: enviar

O elemento input está contido em um form . Use o evento submit encaminhado para obter o valor ao pressionar “Enter”.

< Search bind:value on:submit ={() => console . log ( " submit " , value )} />

Etiqueta com texto de espaço reservado

$$restProps são encaminhados para o elemento de entrada.

< Search label = " My label " placeholder = " Placeholder text... " />

Slot de etiqueta

< Search >
  < span slot = " label " style = " color: red; " >Custom label</ span >
</ Search >

Etiqueta visualmente oculta

Defina hideLabel como true para ocultar visualmente o rótulo.

< Search hideLabel label = " My label " placeholder = " Placeholder text... " />

Foco (declarativo)

Use a propriedade autofocus para focar declarativamente a entrada.

< Search autofocus />

Foco (programático)

Vincule o ref prop para focar programaticamente a entrada.

< script >
  import Search from " svelte-search " ;

  let ref = null ;
</ script >

< Search bind:ref />

< button on:click ={() => ref . focus ()}>Focus</ button >

Entrada devolvida

Use a propriedade debounce para especificar o valor debounce em milissegundos.

< script >
  import Search from " svelte-search " ;

  let events = [];
</ script >

< Search
  debounce ={ 800 }
  on:type ={({ detail : value }) => ( events = [ ... events , value ])}
/>

< pre >{ JSON . stringify ( events , null , 2 )}</ pre >

API

$$restProps são encaminhados para o elemento de entrada.

Adereços

Nome do adereço	Tipo	Valor padrão
valor	string	""
rótulo	string	"Search"
ocultarLabel	boolean	false
rebater	number	0
referência	HTMLInputElement	null
eu ia	string	"search" + Math.random().toString(36)
removeFormAriaAttributes	boolean	false
foco automático	boolean	false

Eventos encaminhados

• ligado: entrada
• em: alterar
• em: enviar
• em: foco
• em: desfoque
• ativado: tecla pressionada

Eventos despachados

• on:type : disparado quando o valor de entrada é atualizado
• on:clear : disparado ao clicar no botão "X" para limpar o valor de entrada

< Search
  on:type ={( e ) => {
    console . log ( " type " , e . detail ); // input value
  }}
  on:clear ={() => {
    console . log ( " clear " );
  }}
/>

Registro de alterações

Registro de alterações

Licença

MIT