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

feat(notification): update TS signature for dispatched close event

Browse source
This commit is contained in:
Eric Liu 2021-01-22 12:20:19 -08:00
commit 7706b28200
8 changed files with 42 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

8
COMPONENT_INDEX.md
View file

@ -1756,12 +1756,12 @@ None.
### Events
| Event name | Type | Detail |
| :--------- | :--------- | :----- |
| :--------- | :--------- | :-------------------------------- |
| close | dispatched | <code>{ timeout: boolean }</code> |
| click | forwarded | -- |
| mouseover | forwarded | -- |
| mouseenter | forwarded | -- |
| mouseleave | forwarded | -- |
| close | dispatched | -- |
## `Link`
@ -3893,12 +3893,12 @@ None.
### Events
| Event name | Type | Detail |
| :--------- | :--------- | :----- |
| :--------- | :--------- | :-------------------------------- |
| close | dispatched | <code>{ timeout: boolean }</code> |
| click | forwarded | -- |
| mouseover | forwarded | -- |
| mouseenter | forwarded | -- |
| mouseleave | forwarded | -- |
| close | dispatched | -- |
## `Toggle`

16
docs/src/COMPONENT_API.json
View file

@ -5772,11 +5772,15 @@
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [
{
"type": "dispatched",
"name": "close",
"detail": "{ timeout: boolean }"
},
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "dispatched", "name": "close" }
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
@ -5871,11 +5875,15 @@
{ "name": "actions", "default": false, "slot_props": "{}" }
],
"events": [
{
"type": "dispatched",
"name": "close",
"detail": "{ timeout: boolean }"
},
{ "type": "forwarded", "name": "click", "element": "div" },
{ "type": "forwarded", "name": "mouseover", "element": "div" },
{ "type": "forwarded", "name": "mouseenter", "element": "div" },
{ "type": "forwarded", "name": "mouseleave", "element": "div" },
{ "type": "dispatched", "name": "close" }
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }

4
src/Notification/InlineNotification.svelte
View file

@ -1,4 +1,8 @@
<script>
/**
* @event {{ timeout: boolean }} close
*/
/**
* Specify the kind of notification
* @type {"error" | "info" | "info-square" | "success" | "warning" | "warning-alt"}

4
src/Notification/ToastNotification.svelte
View file

@ -1,4 +1,8 @@
<script>
/**
* @event {{ timeout: boolean }} close
*/
/**
* Specify the kind of notification
* @type {"error" | "info" | "info-square" | "success" | "warning" | "warning-alt"}

3
tests/InlineNotification.test.svelte
View file

@ -8,6 +8,9 @@
hideCloseButton
kind="warning"
title="Upcoming scheduled maintenance"
on:close="{(e) => {
console.log(e.detail.timeout);
}}"
/>
<InlineNotification kind="warning" title="Upcoming scheduled maintenance">

3
tests/ToastNotification.test.svelte
View file

@ -8,6 +8,9 @@
hideCloseButton
kind="warning"
title="Upcoming scheduled maintenance"
on:close="{(e) => {
console.log(e.detail.timeout);
}}"
/>
<ToastNotification kind="error" />

2
types/Notification/InlineNotification.d.ts vendored
View file

@ -57,10 +57,10 @@ export default class InlineNotification {
actions: {};
};
$on(eventname: "close", cb: (event: CustomEvent<{ timeout: boolean }>) => void): () => void;
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
$on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
$on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
$on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
$on(eventname: "close", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}

2
types/Notification/ToastNotification.d.ts vendored
View file

@ -62,10 +62,10 @@ export default class ToastNotification {
default: {};
};
$on(eventname: "close", cb: (event: CustomEvent<{ timeout: boolean }>) => void): () => void;
$on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
$on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
$on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
$on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
$on(eventname: "close", cb: (event: CustomEvent<any>) => void): () => void;
$on(eventname: string, cb: (event: Event) => void): () => void;
}