svelte search

精简搜索

可访问、可定制的 Svelte 搜索组件。

该搜索组件由语义form和input元素组成。

请参阅 svelte-typeahead 了解带有下拉结果的搜索组件。

在 Svelte REPL 中尝试一下。

---

安装

 # npm
npm i svelte-search

# pnpm
pnpm i svelte-search

# Yarn
yarn add svelte-search

# Bun
bun add svelte-search

造型

该组件在设计上没有样式。使用[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 ;
}

用法

双向绑定

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

  let value = " " ;
</ script >

< Search bind:value />

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

上：提交

input元素包含在form中。使用转发的submit事件来获取按“Enter”键时的值。

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

带有占位符文本的标签

$$restProps被转发到输入元素。

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

标签槽

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

视觉上隐藏的标签

将hideLabel设置为true可在视觉上隐藏标签。

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

焦点（声明性）

使用autofocus属性以声明方式聚焦输入。

< Search autofocus />

焦点（程序化）

绑定ref属性以编程方式聚焦输入。

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

  let ref = null ;
</ script >

< Search bind:ref />

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

去抖输入

使用debounce属性指定 debounce 值（以毫秒为单位）。

< 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 >

应用程序编程接口

$$restProps被转发到输入元素。

道具

道具名称	类型	默认值
价值	string	""
标签	string	"Search"
隐藏标签	boolean	false
去抖	number	0
参考	HTMLInputElement	null
ID	string	"search" + Math.random().toString(36)
删除FormAria属性	boolean	false
自动对焦	boolean	false

转发事件

• 开：输入
• 上：改变
• 上：提交
• 上：焦点
• 开：模糊
• 开：按下键

已调度事件

• on:type ：当输入值更新时触发
• on:clear ：单击“X”按钮清除输入值时触发

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

变更日志

变更日志

执照

麻省理工学院