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

docs: add dispatched event details

Browse source 
Brought in part by sveld 0.18
This commit is contained in:
Enrico Sacchetti 2022-12-12 15:21:54 -05:00
commit 1627fa023f
5 changed files with 38 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/src/COMPONENT_API.json
View file

@ -8406,7 +8406,8 @@
{
"type": "dispatched",
"name": "change",
"detail": "{ page?: number; pageSize?: number }"
"detail": "{ page?: number; pageSize?: number }",
"description": "Dispatched after any user interaction"
},
{
"type": "dispatched",
@ -10257,7 +10258,12 @@
}
],
"events": [
{ "type": "dispatched", "name": "update", "detail": "string | number" },
{
"type": "dispatched",
"name": "update",
"detail": "string | number",
"description": "The selected value."
},
{ "type": "forwarded", "name": "change", "element": "select" },
{ "type": "forwarded", "name": "input", "element": "select" },
{ "type": "forwarded", "name": "focus", "element": "select" },

32
docs/src/components/ComponentApi.svelte
View file

@ -168,11 +168,33 @@
<h2 id="dispatched-events">Dispatched events</h2>
{#if dispatched_events.length > 0}
<UnorderedList class="my-layout-01-03">
{#each dispatched_events as event (event.name)}
<ListItem>on:{event.name}</ListItem>
{/each}
</UnorderedList>
{@const hasDescription = dispatched_events.find((el) => el.description)}
<StructuredList flush>
<StructuredListHead>
<StructuredListRow>
<StructuredListCell>Event name</StructuredListCell>
<StructuredListCell><code>event.details</code> type</StructuredListCell>
{#if hasDescription}
<StructuredListCell>Description</StructuredListCell>
{/if}
</StructuredListRow>
</StructuredListHead>
<StructuredListBody>
{#each dispatched_events as event (event.name)}
<StructuredListRow>
<StructuredListCell>
<strong>on:{event.name}</strong>
</StructuredListCell>
<StructuredListCell>
<code>{event.detail}</code>
</StructuredListCell>
<StructuredListCell>
{event.description ?? ""}
</StructuredListCell>
</StructuredListRow>
{/each}
</StructuredListBody>
</StructuredList>
{:else}
<p class="my-layout-01-03">No dispatched events.</p>
{/if}