Skip to content

Commit cae727f

Browse files
liamdebeasiliamdebeasi
authored
refactor(api): v5 docs use internal import (#2929)
1 parent d6659e1 commit cae727f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+1781
-5808
lines changed

‎versioned_docs/version-v5/api/action-sheet.md

+16-153
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ demoSourceUrl: 'https://github.com/ionic-team/ionic-docs/tree/main/static/demos/
77
import Tabs from '@theme/Tabs';
88
import TabItem from '@theme/TabItem';
99

10+
import Props from '@ionic-internal/component-api/v5/action-sheet/props.md';
11+
import Events from '@ionic-internal/component-api/v5/action-sheet/events.md';
12+
import Methods from '@ionic-internal/component-api/v5/action-sheet/methods.md';
13+
import Parts from '@ionic-internal/component-api/v5/action-sheet/parts.md';
14+
import CustomProps from '@ionic-internal/component-api/v5/action-sheet/custom-props.md';
15+
import Slots from '@ionic-internal/component-api/v5/action-sheet/slots.md';
16+
1017
# ion-action-sheet
1118

1219
An Action Sheet is a dialog that displays a set of options. It appears on top of the app's content, and must be manually dismissed by the user before they can resume interaction with the app. Destructive options are made obvious in `ios` mode. There are multiple ways to dismiss the action sheet, including tapping the backdrop or hitting the escape key on desktop.
@@ -505,168 +512,24 @@ Developers can also use this component directly in their template:
505512

506513
## Properties
507514

508-
### animated
509-
510-
| | |
511-
| --------------- | ----------------------------------------- |
512-
| **Description** | If `true`, the action sheet will animate. |
513-
| **Attribute** | `animated` |
514-
| **Type** | `boolean` |
515-
| **Default** | `true` |
516-
517-
### backdropDismiss
518-
519-
| | |
520-
| --------------- | --------------------------------------------------------------------------- |
521-
| **Description** | If `true`, the action sheet will be dismissed when the backdrop is clicked. |
522-
| **Attribute** | `backdrop-dismiss` |
523-
| **Type** | `boolean` |
524-
| **Default** | `true` |
525-
526-
### buttons
527-
528-
| | |
529-
| --------------- | ----------------------------------------- |
530-
| **Description** | An array of buttons for the action sheet. |
531-
| **Attribute** | `undefined` |
532-
| **Type** | `(string \| ActionSheetButton)[]` |
533-
| **Default** | `[]` |
534-
535-
### cssClass
536-
537-
| | |
538-
| --------------- | --------------------------------------------------------------------------------------------------------------------- |
539-
| **Description** | Additional classes to apply for custom CSS. If multiple classes are<br />provided they should be separated by spaces. |
540-
| **Attribute** | `css-class` |
541-
| **Type** | `string \| string[] \| undefined` |
542-
| **Default** | `undefined` |
543-
544-
### enterAnimation
545-
546-
| | |
547-
| --------------- | ------------------------------------------------------- |
548-
| **Description** | Animation to use when the action sheet is presented. |
549-
| **Attribute** | `undefined` |
550-
| **Type** | `((baseEl: any, opts?: any) => Animation) \| undefined` |
551-
| **Default** | `undefined` |
552-
553-
### header
554-
555-
| | |
556-
| --------------- | --------------------------- |
557-
| **Description** | Title for the action sheet. |
558-
| **Attribute** | `header` |
559-
| **Type** | `string \| undefined` |
560-
| **Default** | `undefined` |
561-
562-
### keyboardClose
563-
564-
| | |
565-
| --------------- | -------------------------------------------------------------------------------------- |
566-
| **Description** | If `true`, the keyboard will be automatically dismissed when the overlay is presented. |
567-
| **Attribute** | `keyboard-close` |
568-
| **Type** | `boolean` |
569-
| **Default** | `true` |
570-
571-
### leaveAnimation
572-
573-
| | |
574-
| --------------- | ------------------------------------------------------- |
575-
| **Description** | Animation to use when the action sheet is dismissed. |
576-
| **Attribute** | `undefined` |
577-
| **Type** | `((baseEl: any, opts?: any) => Animation) \| undefined` |
578-
| **Default** | `undefined` |
579-
580-
### mode
581-
582-
| | |
583-
| --------------- | ------------------------------------------------- |
584-
| **Description** | The mode determines which platform styles to use. |
585-
| **Attribute** | `mode` |
586-
| **Type** | `"ios" \| "md"` |
587-
| **Default** | `undefined` |
588-
589-
### subHeader
590-
591-
| | |
592-
| --------------- | ------------------------------ |
593-
| **Description** | Subtitle for the action sheet. |
594-
| **Attribute** | `sub-header` |
595-
| **Type** | `string \| undefined` |
596-
| **Default** | `undefined` |
597-
598-
### translucent
599-
600-
| | |
601-
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
602-
| **Description** | If `true`, the action sheet will be translucent.<br />Only applies when the mode is `"ios"` and the device supports<br />[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility). |
603-
| **Attribute** | `translucent` |
604-
| **Type** | `boolean` |
605-
| **Default** | `false` |
515+
<Props />
606516

607517
## Events
608518

609-
| Name | Description |
610-
| --------------------------- | --------------------------------------- |
611-
| `ionActionSheetDidDismiss` | Emitted after the alert has dismissed. |
612-
| `ionActionSheetDidPresent` | Emitted after the alert has presented. |
613-
| `ionActionSheetWillDismiss` | Emitted before the alert has dismissed. |
614-
| `ionActionSheetWillPresent` | Emitted before the alert has presented. |
519+
<Events />
615520

616521
## Methods
617522

618-
### dismiss
619-
620-
| | |
621-
| --------------- | --------------------------------------------------------------------- |
622-
| **Description** | Dismiss the action sheet overlay after it has been presented. |
623-
| **Signature** | `dismiss(data?: any, role?: string \| undefined) => Promise<boolean>` |
624-
625-
### onDidDismiss
523+
<Methods />
626524

627-
| | |
628-
| --------------- | ------------------------------------------------------------------ |
629-
| **Description** | Returns a promise that resolves when the action sheet did dismiss. |
630-
| **Signature** | `onDidDismiss<T = any>() => Promise<OverlayEventDetail<T>>` |
525+
## CSS Shadow Parts
631526

632-
### onWillDismiss
527+
<Parts />
633528

634-
| | |
635-
| --------------- | ------------------------------------------------------------------- |
636-
| **Description** | Returns a promise that resolves when the action sheet will dismiss. |
637-
| **Signature** | `onWillDismiss<T = any>() => Promise<OverlayEventDetail<T>>` |
638-
639-
### present
529+
## CSS Custom Properties
640530

641-
| | |
642-
| --------------- | ----------------------------------------------------------- |
643-
| **Description** | Present the action sheet overlay after it has been created. |
644-
| **Signature** | `present() => Promise<void>` |
531+
<CustomProps />
645532

646-
## CSS Custom Properties
533+
## Slots
647534

648-
| Name | Description |
649-
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
650-
| `--backdrop-opacity` | Opacity of the backdrop |
651-
| `--background` | Background of the action sheet group |
652-
| `--button-background` | Background of the action sheet button |
653-
| `--button-background-activated` | Background of the action sheet button when pressed. Note: setting this will interfere with the Material Design ripple. |
654-
| `--button-background-activated-opacity` | Opacity of the action sheet button background when pressed |
655-
| `--button-background-focused` | Background of the action sheet button when tabbed to |
656-
| `--button-background-focused-opacity` | Opacity of the action sheet button background when tabbed to |
657-
| `--button-background-hover` | Background of the action sheet button on hover |
658-
| `--button-background-hover-opacity` | Opacity of the action sheet button background on hover |
659-
| `--button-background-selected` | Background of the selected action sheet button |
660-
| `--button-background-selected-opacity` | Opacity of the selected action sheet button background |
661-
| `--button-color` | Color of the action sheet button |
662-
| `--button-color-activated` | Color of the action sheet button when pressed |
663-
| `--button-color-focused` | Color of the action sheet button when tabbed to |
664-
| `--button-color-hover` | Color of the action sheet button on hover |
665-
| `--button-color-selected` | Color of the selected action sheet button |
666-
| `--color` | Color of the action sheet text |
667-
| `--height` | height of the action sheet |
668-
| `--max-height` | Maximum height of the action sheet |
669-
| `--max-width` | Maximum width of the action sheet |
670-
| `--min-height` | Minimum height of the action sheet |
671-
| `--min-width` | Minimum width of the action sheet |
672-
| `--width` | Width of the action sheet |
535+
<Slots />

0 commit comments

Comments
 (0)