feat(all): add CustomEvents types to components that emit events (#23956)

resolves #22925

BREAKING CHANGE: The `RadioChangeEventDetail` interface has been removed in favor of `RadioGroupChangeEventDetail`.
This commit is contained in:
Liam DeBeasi
2021-09-24 16:28:49 -04:00
committed by GitHub
parent 285a371101
commit 8708095111
48 changed files with 763 additions and 58 deletions

View File

@ -2,3 +2,8 @@ export interface BreadcrumbCollapsedClickEventDetail {
ionShadowTarget?: HTMLElement;
collapsedBreadcrumbs?: HTMLIonBreadcrumbElement[];
}
export interface BreadcrumbCustomEvent extends CustomEvent {
detail: BreadcrumbCollapsedClickEventDetail;
target: HTMLIonBreadcrumbElement;
}

View File

@ -2,6 +2,27 @@
A Breadcrumb is a single navigation item that is a child of the Breadcrumbs component. A breadcrumb can link elsewhere in an app or it can be plain text. Each breadcrumb has a separator between it and the next breadcrumb and can optionally contain an icon.
## Interfaces
### BreadcrumbCollapsedClickEventDetail
```typescript
interface BreadcrumbCollapsedClickEventDetail {
collapsedBreadcrumbs?: HTMLIonBreadcrumbElement[];
}
```
### BreadcrumbCustomEvent
While not required, this interface can be used in place of the `CustomEvent` interface for stronger typing .
```typescript
interface BreadcrumbCustomEvent extends CustomEvent {
detail: BreadcrumbCollapsedClickEventDetail;
target: HTMLIonBreadcrumbElement;
}
```
<!-- Auto Generated Below -->