mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-18 03:26:36 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix(ui-shell): dispatched event is "select", not "search"

Browse source
This commit is contained in:
Eric Liu 2020-11-26 14:19:30 -08:00
commit 5fe3f6d830
5 changed files with 7 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

3
COMPONENT_INDEX.md
View file

@ -1643,13 +1643,12 @@ export interface HeaderSearchResult {
| Event name | Type | Detail |
| :--------- | :--------- | :---------------------------------------------------------------------------------------------- |
| clear | dispatched | <code>any</code> |
| search | dispatched | <code>{ value: string; selectedResultIndex: number; selectedResult: HeaderSearchResult }</code> |
| select | dispatched | <code>{ value: string; selectedResultIndex: number; selectedResult: HeaderSearchResult }</code> |
| change | forwarded | -- |
| input | forwarded | -- |
| focus | forwarded | -- |
| blur | forwarded | -- |
| keydown | forwarded | -- |
| select | dispatched | -- |
## `HeaderUtilities`

5
docs/src/COMPONENT_API.json
View file

@ -10325,15 +10325,14 @@
{ "type": "dispatched", "name": "clear", "detail": "any" },
{
"type": "dispatched",
"name": "search",
"name": "select",
"detail": "{ value: string; selectedResultIndex: number; selectedResult: HeaderSearchResult }"
},
{ "type": "forwarded", "name": "change", "element": "input" },
{ "type": "forwarded", "name": "input", "element": "input" },
{ "type": "forwarded", "name": "focus", "element": "input" },
{ "type": "forwarded", "name": "blur", "element": "input" },
{ "type": "forwarded", "name": "keydown", "element": "input" },
{ "type": "dispatched", "name": "select" }
{ "type": "forwarded", "name": "keydown", "element": "input" }
],
"typedefs": [
{

7
docs/src/pages/framed/UIShell/HeaderSearch.svelte
View file

@ -63,17 +63,14 @@
bind:ref
bind:active
bind:value
on:search="{(e) => {
console.log('on:search', e.detail);
}}"
bind:selectedResultIndex
results="{results}"
on:clear="{() => {
console.log('on:clear');
}}"
on:select="{(e) => {
console.log('on:select', e.detail);
}}"
results="{results}"
bind:selectedResultIndex
/>
<HeaderAction bind:isOpen>
<HeaderPanelLinks>

2
src/UIShell/HeaderSearch.svelte
View file

@ -2,7 +2,7 @@
/**
* @typedef {{ href: string; text: string; description?: string; }} HeaderSearchResult
* @event {any} clear
* @event {{ value: string; selectedResultIndex: number; selectedResult: HeaderSearchResult }} search
* @event {{ value: string; selectedResultIndex: number; selectedResult: HeaderSearchResult }} select
*/
/** Specify the search input value */

3
types/UIShell/HeaderSearch.d.ts vendored
View file

@ -46,7 +46,7 @@ export default class HeaderSearch {
$on(eventname: "clear", cb: (event: CustomEvent<any>) => void): () => void;
$on(
eventname: "search",
eventname: "select",
cb: (event: CustomEvent<{ value: string; selectedResultIndex: number; selectedResult: HeaderSearchResult }>) => void
): () => void;
$on(eventname: "change", cb: (event: WindowEventMap["change"]) => void): () => void;
@ -54,6 +54,5 @@ export default class HeaderSearch {
$on(eventname: "focus", cb: (event: WindowEventMap["focus"]) => void): () => void;
$on(eventname: "blur", cb: (event: WindowEventMap["blur"]) => void): () => void;
$on(eventname: "keydown", cb: (event: WindowEventMap["keydown"]) => void): () => void;
$on(eventname: "select", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}