javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-22 21:48:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(): remove code blocks in docs

Browse Source
This commit is contained in:
mhartington
2018-05-31 16:13:53 -04:00
parent 5ad35ccc00
commit aaf3eee59d
21 changed files with 98 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
core/package-lock.json generated
View File

@ -4501,9 +4501,9 @@
} }
}, },
"http-parser-js": { "http-parser-js": {
"version": "0.4.12", "version": "0.4.13",
"resolved": "https://registry.npmjs.org/http-parser-js/-/http-parser-js-0.4.12.tgz", "resolved": "https://registry.npmjs.org/http-parser-js/-/http-parser-js-0.4.13.tgz",
"integrity": "sha1-uc+/Sizybw/DSxDKFImid3HjR08=", "integrity": "sha1-O9bW/ebjFyyTNMOzO2wZPYD+ETc=",
"dev": true "dev": true
}, },
"http-signature": { "http-signature": {

80
core/src/components.d.ts vendored
View File

@ -185,11 +185,11 @@ declare global {
*/ */
'leaveAnimation': AnimationBuilder; 'leaveAnimation': AnimationBuilder;
/** /**
* Returns a promise that resolves when the action-sheet did dismiss. It also accepts a callback that is called in the same circustances. ``` const {data, role} = await actionSheet.onDidDismiss(); ``` * Returns a promise that resolves when the action-sheet did dismiss. It also accepts a callback that is called in the same circustances.
*/ */
'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
/** /**
* Returns a promise that resolves when the action-sheet will dismiss. It also accepts a callback that is called in the same circustances. ``` const {data, role} = await actionSheet.onWillDismiss(); ``` * Returns a promise that resolves when the action-sheet will dismiss. It also accepts a callback that is called in the same circustances.
*/ */
'onWillDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onWillDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
/** /**
@ -394,11 +394,11 @@ declare global {
'message': string; 'message': string;
'mode': Mode; 'mode': Mode;
/** /**
* Returns a promise that resolves when the alert did dismiss. It also accepts a callback that is called in the same circumstances. ``` const {data, role} = await alert.onDidDismiss(); ``` * Returns a promise that resolves when the alert did dismiss. It also accepts a callback that is called in the same circumstances.
*/ */
'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
/** /**
* Returns a promise that resolves when the alert will dismiss. It also accepts a callback that is called in the same circumstances. ``` const {data, role} = await alert.onWillDismiss(); ``` * Returns a promise that resolves when the alert will dismiss. It also accepts a callback that is called in the same circumstances.
*/ */
'onWillDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onWillDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
'overlayId': number; 'overlayId': number;
@ -3071,12 +3071,12 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonLabel { interface IonLabel {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information, see [Theming your App](/docs/theming/theming-your-app). * The color to use for the label's text
*/ */
'color': Color; 'color': Color;
'getText': () => string; 'getText': () => string;
/** /**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. For more information, see [Platform Styles](/docs/theming/platform-specific-styles). * The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/ */
'mode': Mode; 'mode': Mode;
/** /**
@ -3106,11 +3106,11 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonLabelAttributes extends HTMLAttributes { export interface IonLabelAttributes extends HTMLAttributes {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information, see [Theming your App](/docs/theming/theming-your-app). * The color to use for the label's text
*/ */
'color'?: Color; 'color'?: Color;
/** /**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. For more information, see [Platform Styles](/docs/theming/platform-specific-styles). * The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/ */
'mode'?: Mode; 'mode'?: Mode;
/** /**
@ -3131,11 +3131,11 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonListHeader { interface IonListHeader {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information, see [Theming your App](/docs/theming/theming-your-app). * The color to use for the background.
*/ */
'color': Color; 'color': Color;
/** /**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. For more information, see [Platform Styles](/docs/theming/platform-specific-styles). * The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/ */
'mode': Mode; 'mode': Mode;
} }
@ -3161,11 +3161,11 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonListHeaderAttributes extends HTMLAttributes { export interface IonListHeaderAttributes extends HTMLAttributes {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information, see [Theming your App](/docs/theming/theming-your-app). * The color to use for the background.
*/ */
'color'?: Color; 'color'?: Color;
/** /**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. For more information, see [Platform Styles](/docs/theming/platform-specific-styles). * The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/ */
'mode'?: Mode; 'mode'?: Mode;
} }
@ -3228,8 +3228,17 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonLoadingController { interface IonLoadingController {
/**
* Create a loading overlay with loading options.
*/
'create': (opts?: LoadingOptions | undefined) => Promise<HTMLIonLoadingElement | null>; 'create': (opts?: LoadingOptions | undefined) => Promise<HTMLIonLoadingElement | null>;
/**
* Dismiss the open loading overlay.
*/
'dismiss': (data?: any, role?: string | undefined, loadingId?: number) => Promise<void>; 'dismiss': (data?: any, role?: string | undefined, loadingId?: number) => Promise<void>;
/**
* Get the most recently opened loading overlay.
*/
'getTop': () => HTMLIonLoadingElement; 'getTop': () => HTMLIonLoadingElement;
} }
} }
@ -3297,7 +3306,7 @@ declare global {
*/ */
'leaveAnimation': AnimationBuilder; 'leaveAnimation': AnimationBuilder;
/** /**
* Returns a promise that resolves when the loading did dismiss. It also accepts a callback that is called in the same circustances. ``` const {data, role} = await loading.onDidDismiss(); ``` * Returns a promise that resolves when the loading did dismiss. It also accepts a callback that is called in the same circustances.
*/ */
'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
/** /**
@ -3478,7 +3487,7 @@ declare global {
'_setOpen': (menu: Menu, shouldOpen: boolean, animated: boolean) => Promise<boolean>; '_setOpen': (menu: Menu, shouldOpen: boolean, animated: boolean) => Promise<boolean>;
'_unregister': (menu: Menu) => void; '_unregister': (menu: Menu) => void;
/** /**
* Programatically close the Menu. If no `menuId` is given as the first argument then it'll close any menu which is open. If a `menuId` is given then it'll close that exact menu. * Close the Menu. If no `menuId` is given as the first argument then it'll close any menu which is open. If a `menuId` is given then it'll close that exact menu.
*/ */
'close': (menuId?: string | undefined) => Promise<boolean>; 'close': (menuId?: string | undefined) => Promise<boolean>;
'createAnimation': (type: string, menuCmp: Menu) => Promise<Animation>; 'createAnimation': (type: string, menuCmp: Menu) => Promise<Animation>;
@ -3490,13 +3499,28 @@ declare global {
* Used to get a menu instance. If a `menuId` is not provided then it'll return the first menu found. If a `menuId` is `left` or `right`, then it'll return the enabled menu on that side. Otherwise, if a `menuId` is provided, then it'll try to find the menu using the menu's `id` property. If a menu is not found then it'll return `null`. * Used to get a menu instance. If a `menuId` is not provided then it'll return the first menu found. If a `menuId` is `left` or `right`, then it'll return the enabled menu on that side. Otherwise, if a `menuId` is provided, then it'll try to find the menu using the menu's `id` property. If a menu is not found then it'll return `null`.
*/ */
'get': (menuId?: string | undefined) => HTMLIonMenuElement | null; 'get': (menuId?: string | undefined) => HTMLIonMenuElement | null;
/**
* Returns an array of all menu instances.
*/
'getMenus': () => HTMLIonMenuElement[]; 'getMenus': () => HTMLIonMenuElement[];
/**
* Returns the instance of the menu already opened, otherwise `null`.
*/
'getOpen': () => HTMLIonMenuElement | null; 'getOpen': () => HTMLIonMenuElement | null;
/**
* If any menu is currently animating
*/
'isAnimating': () => boolean; 'isAnimating': () => boolean;
/**
* Returns true or false if the menuId is enabled or not
*/
'isEnabled': (menuId?: string | undefined) => boolean; 'isEnabled': (menuId?: string | undefined) => boolean;
/**
* If the menuId is not specified, it returns true if ANY menu is currenly open.
*/
'isOpen': (menuId?: string | undefined) => boolean; 'isOpen': (menuId?: string | undefined) => boolean;
/** /**
* Programatically open the Menu. * Open the Menu.
*/ */
'open': (menuId?: string | undefined) => Promise<boolean>; 'open': (menuId?: string | undefined) => Promise<boolean>;
'registerAnimation': (name: string, animation: AnimationBuilder) => void; 'registerAnimation': (name: string, animation: AnimationBuilder) => void;
@ -3598,6 +3622,9 @@ declare global {
'disabled': boolean; 'disabled': boolean;
'isActive': () => boolean; 'isActive': () => boolean;
'isOpen': () => boolean; 'isOpen': () => boolean;
/**
* The edge threshold for dragging the menu open. If a drag/swipe happens over this value, the menu is not triggered.
*/
'maxEdgeStart': number; 'maxEdgeStart': number;
/** /**
* An id for the menu. * An id for the menu.
@ -3619,7 +3646,7 @@ declare global {
'swipeEnabled': boolean; 'swipeEnabled': boolean;
'toggle': (animated?: boolean) => Promise<boolean>; 'toggle': (animated?: boolean) => Promise<boolean>;
/** /**
* The display type of the menu. Default varies based on the mode, see the `menuType` in the [config](../../config/Config). Available options: `"overlay"`, `"reveal"`, `"push"`. * The display type of the menu. Available options: `"overlay"`, `"reveal"`, `"push"`.
*/ */
'type': string; 'type': string;
} }
@ -3652,6 +3679,9 @@ declare global {
* If true, the menu is disabled. Default `false`. * If true, the menu is disabled. Default `false`.
*/ */
'disabled'?: boolean; 'disabled'?: boolean;
/**
* The edge threshold for dragging the menu open. If a drag/swipe happens over this value, the menu is not triggered.
*/
'maxEdgeStart'?: number; 'maxEdgeStart'?: number;
/** /**
* An id for the menu. * An id for the menu.
@ -3679,7 +3709,7 @@ declare global {
*/ */
'swipeEnabled'?: boolean; 'swipeEnabled'?: boolean;
/** /**
* The display type of the menu. Default varies based on the mode, see the `menuType` in the [config](../../config/Config). Available options: `"overlay"`, `"reveal"`, `"push"`. * The display type of the menu. Available options: `"overlay"`, `"reveal"`, `"push"`.
*/ */
'type'?: string; 'type'?: string;
} }
@ -3765,11 +3795,11 @@ declare global {
*/ */
'mode': Mode; 'mode': Mode;
/** /**
* Returns a promise that resolves when the modal did dismiss. It also accepts a callback that is called in the same circustances. ``` const {data, role} = await modal.onDidDismiss(); ``` * Returns a promise that resolves when the modal did dismiss. It also accepts a callback that is called in the same circustances.
*/ */
'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
/** /**
* Returns a promise that resolves when the modal will dismiss. It also accepts a callback that is called in the same circustances. ``` const {data, role} = await modal.onWillDismiss(); ``` * Returns a promise that resolves when the modal will dismiss. It also accepts a callback that is called in the same circustances.
*/ */
'onWillDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onWillDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
'overlayId': number; 'overlayId': number;
@ -4199,11 +4229,11 @@ declare global {
*/ */
'leaveAnimation': AnimationBuilder; 'leaveAnimation': AnimationBuilder;
/** /**
* Returns a promise that resolves when the picker did dismiss. It also accepts a callback that is called in the same circustances. ``` const {data, role} = await picker.onDidDismiss(); ``` * Returns a promise that resolves when the picker did dismiss. It also accepts a callback that is called in the same circustances.
*/ */
'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
/** /**
* Returns a promise that resolves when the picker will dismiss. It also accepts a callback that is called in the same circustances. ``` const {data, role} = await picker.onWillDismiss(); ``` * Returns a promise that resolves when the picker will dismiss. It also accepts a callback that is called in the same circustances.
*/ */
'onWillDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onWillDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
'overlayId': number; 'overlayId': number;
@ -4390,11 +4420,11 @@ declare global {
*/ */
'mode': Mode; 'mode': Mode;
/** /**
* Returns a promise that resolves when the popover did dismiss. It also accepts a callback that is called in the same circustances. ``` const {data, role} = await popover.onDidDismiss(); ``` * Returns a promise that resolves when the popover did dismiss. It also accepts a callback that is called in the same circustances.
*/ */
'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
/** /**
* Returns a promise that resolves when the popover will dismiss. It also accepts a callback that is called in the same circustances. ``` const {data, role} = await popover.onWillDismiss(); ``` * Returns a promise that resolves when the popover will dismiss. It also accepts a callback that is called in the same circustances.
*/ */
'onWillDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onWillDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
'overlayId': number; 'overlayId': number;
@ -7108,11 +7138,11 @@ declare global {
*/ */
'message': string; 'message': string;
/** /**
* Returns a promise that resolves when the toast did dismiss. It also accepts a callback that is called in the same circustances. ``` const {data, role} = await toast.onDidDismiss(); ``` * Returns a promise that resolves when the toast did dismiss. It also accepts a callback that is called in the same circustances.
*/ */
'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onDidDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
/** /**
* Returns a promise that resolves when the toast will dismiss. It also accepts a callback that is called in the same circustances. ``` const {data, role} = await toast.onWillDismiss(); ``` * Returns a promise that resolves when the toast will dismiss. It also accepts a callback that is called in the same circustances.
*/ */
'onWillDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>; 'onWillDismiss': (callback?: ((detail: OverlayEventDetail) => void) | undefined) => Promise<OverlayEventDetail>;
'overlayId': number; 'overlayId': number;

6
core/src/components/action-sheet/action-sheet.tsx
View File

@ -160,9 +160,6 @@ export class ActionSheet implements OverlayInterface {
* Returns a promise that resolves when the action-sheet did dismiss. It also accepts a callback * Returns a promise that resolves when the action-sheet did dismiss. It also accepts a callback
* that is called in the same circustances. * that is called in the same circustances.
* *
* ```
* const {data, role} = await actionSheet.onDidDismiss();
* ```
*/ */
@Method() @Method()
onDidDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> { onDidDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> {
@ -173,9 +170,6 @@ export class ActionSheet implements OverlayInterface {
* Returns a promise that resolves when the action-sheet will dismiss. It also accepts a callback * Returns a promise that resolves when the action-sheet will dismiss. It also accepts a callback
* that is called in the same circustances. * that is called in the same circustances.
* *
* ```
* const {data, role} = await actionSheet.onWillDismiss();
* ```
*/ */
@Method() @Method()
onWillDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> { onWillDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> {

8
core/src/components/action-sheet/readme.md
View File

@ -218,20 +218,12 @@ Dismiss the action sheet overlay after it has been presented.
Returns a promise that resolves when the action-sheet did dismiss. It also accepts a callback Returns a promise that resolves when the action-sheet did dismiss. It also accepts a callback
that is called in the same circustances. that is called in the same circustances.
```
const {data, role} = await actionSheet.onDidDismiss();
```
#### onWillDismiss() #### onWillDismiss()
Returns a promise that resolves when the action-sheet will dismiss. It also accepts a callback Returns a promise that resolves when the action-sheet will dismiss. It also accepts a callback
that is called in the same circustances. that is called in the same circustances.
```
const {data, role} = await actionSheet.onWillDismiss();
```
#### present() #### present()

6
core/src/components/alert/alert.tsx
View File

@ -195,9 +195,6 @@ export class Alert implements OverlayInterface {
* Returns a promise that resolves when the alert did dismiss. It also accepts a callback * Returns a promise that resolves when the alert did dismiss. It also accepts a callback
* that is called in the same circumstances. * that is called in the same circumstances.
* *
* ```
* const {data, role} = await alert.onDidDismiss();
* ```
*/ */
@Method() @Method()
onDidDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> { onDidDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> {
@ -208,9 +205,6 @@ export class Alert implements OverlayInterface {
* Returns a promise that resolves when the alert will dismiss. It also accepts a callback * Returns a promise that resolves when the alert will dismiss. It also accepts a callback
* that is called in the same circumstances. * that is called in the same circumstances.
* *
* ```
* const {data, role} = await alert.onWillDismiss();
* ```
*/ */
@Method() @Method()
onWillDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> { onWillDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> {

8
core/src/components/alert/readme.md
View File

@ -257,20 +257,12 @@ Dismiss the alert overlay after it has been presented.
Returns a promise that resolves when the alert did dismiss. It also accepts a callback Returns a promise that resolves when the alert did dismiss. It also accepts a callback
that is called in the same circumstances. that is called in the same circumstances.
```
const {data, role} = await alert.onDidDismiss();
```
#### onWillDismiss() #### onWillDismiss()
Returns a promise that resolves when the alert will dismiss. It also accepts a callback Returns a promise that resolves when the alert will dismiss. It also accepts a callback
that is called in the same circumstances. that is called in the same circumstances.
```
const {data, role} = await alert.onWillDismiss();
```
#### present() #### present()

10
core/src/components/label/readme.md
View File

@ -11,9 +11,7 @@ Label is a wrapper element that can be used in combination with `ion-item`.
string string
The color to use from your Sass `$colors` map. The color to use for the label's text
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information, see [Theming your App](/docs/theming/theming-your-app).
#### mode #### mode
@ -22,7 +20,6 @@ string
The mode determines which platform styles to use. The mode determines which platform styles to use.
Possible values are: `"ios"` or `"md"`. Possible values are: `"ios"` or `"md"`.
For more information, see [Platform Styles](/docs/theming/platform-specific-styles).
#### position #### position
@ -39,9 +36,7 @@ Possible values are: 'inline' | 'fixed' | 'stacked' | 'floating'
string string
The color to use from your Sass `$colors` map. The color to use for the label's text
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information, see [Theming your App](/docs/theming/theming-your-app).
#### mode #### mode
@ -50,7 +45,6 @@ string
The mode determines which platform styles to use. The mode determines which platform styles to use.
Possible values are: `"ios"` or `"md"`. Possible values are: `"ios"` or `"md"`.
For more information, see [Platform Styles](/docs/theming/platform-specific-styles).
#### position #### position

10
core/src/components/list-header/readme.md
View File

@ -11,9 +11,7 @@ List header a header component for a list.
string string
The color to use from your Sass `$colors` map. The color to use for the background.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information, see [Theming your App](/docs/theming/theming-your-app).
#### mode #### mode
@ -22,7 +20,6 @@ string
The mode determines which platform styles to use. The mode determines which platform styles to use.
Possible values are: `"ios"` or `"md"`. Possible values are: `"ios"` or `"md"`.
For more information, see [Platform Styles](/docs/theming/platform-specific-styles).
## Attributes ## Attributes
@ -31,9 +28,7 @@ For more information, see [Platform Styles](/docs/theming/platform-specific-styl
string string
The color to use from your Sass `$colors` map. The color to use for the background.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information, see [Theming your App](/docs/theming/theming-your-app).
#### mode #### mode
@ -42,7 +37,6 @@ string
The mode determines which platform styles to use. The mode determines which platform styles to use.
Possible values are: `"ios"` or `"md"`. Possible values are: `"ios"` or `"md"`.
For more information, see [Platform Styles](/docs/theming/platform-specific-styles).

6
core/src/components/loading-controller/readme.md
View File

@ -12,12 +12,18 @@ Loading controllers programmatically control the loading component. Loadings can
#### create() #### create()
Create a loading overlay with loading options.
#### dismiss() #### dismiss()
Dismiss the open loading overlay.
#### getTop() #### getTop()
Get the most recently opened loading overlay.
---------------------------------------------- ----------------------------------------------

4
core/src/components/loading/readme.md
View File

@ -242,10 +242,6 @@ Dismiss the loading overlay after it has been presented.
Returns a promise that resolves when the loading did dismiss. It also accepts a callback Returns a promise that resolves when the loading did dismiss. It also accepts a callback
that is called in the same circustances. that is called in the same circustances.
```
const {data, role} = await loading.onDidDismiss();
```
#### onWillDismiss() #### onWillDismiss()

14
core/src/components/menu-controller/readme.md
View File

@ -22,7 +22,7 @@ The MenuController makes it easy to control a Menu. Its methods can be used to d
#### close() #### close()
Programatically close the Menu. If no `menuId` is given as the first Close the Menu. If no `menuId` is given as the first
argument then it'll close any menu which is open. If a `menuId` argument then it'll close any menu which is open. If a `menuId`
is given then it'll close that exact menu. is given then it'll close that exact menu.
@ -49,22 +49,32 @@ property. If a menu is not found then it'll return `null`.
#### getMenus() #### getMenus()
Returns an array of all menu instances.
#### getOpen() #### getOpen()
Returns the instance of the menu already opened, otherwise `null`.
#### isAnimating() #### isAnimating()
If any menu is currently animating
#### isEnabled() #### isEnabled()
Returns true or false if the menuId is enabled or not
#### isOpen() #### isOpen()
If the menuId is not specified, it returns true if ANY menu is currenly open.
#### open() #### open()
Programatically open the Menu. Open the Menu.
#### registerAnimation() #### registerAnimation()

14
core/src/components/menu-toggle/readme.md
View File

@ -11,15 +11,16 @@ The MenuToggle component can be used to toggle a menu open or closed.
boolean boolean
Automatically hides the content when the corresponding menu is not Automatically hides the content when the corresponding menu is not active
active
#### menu #### menu
string string
Optional property that maps to a Menu's `menuId` prop. Can also be `left` or `right` for the menu side. This is used to find the correct menu to toggle Optional property that maps to a Menu's `menuId` prop.
Can also be `left` or `right` for the menu side.
This is used to find the correct menu to toggle
## Attributes ## Attributes
@ -28,15 +29,16 @@ Optional property that maps to a Menu's `menuId` prop. Can also be `left` or `ri
boolean boolean
Automatically hides the content when the corresponding menu is not Automatically hides the content when the corresponding menu is not active
active
#### menu #### menu
string string
Optional property that maps to a Menu's `menuId` prop. Can also be `left` or `right` for the menu side. This is used to find the correct menu to toggle Optional property that maps to a Menu's `menuId` prop.
Can also be `left` or `right` for the menu side.
This is used to find the correct menu to toggle

16
core/src/components/menu/readme.md
View File

@ -31,6 +31,9 @@ If true, the menu is disabled. Default `false`.
number number
The edge threshold for dragging the menu open.
If a drag/swipe happens over this value, the menu is not triggered.
#### menuId #### menuId
@ -64,9 +67,8 @@ If true, swiping the menu is enabled. Default `true`.
string string
The display type of the menu. Default varies based on the mode, The display type of the menu.
see the `menuType` in the [config](../../config/Config). Available options: Available options: `"overlay"`, `"reveal"`, `"push"`.
`"overlay"`, `"reveal"`, `"push"`.
## Attributes ## Attributes
@ -89,6 +91,9 @@ If true, the menu is disabled. Default `false`.
number number
The edge threshold for dragging the menu open.
If a drag/swipe happens over this value, the menu is not triggered.
#### menu-id #### menu-id
@ -122,9 +127,8 @@ If true, swiping the menu is enabled. Default `true`.
string string
The display type of the menu. Default varies based on the mode, The display type of the menu.
see the `menuType` in the [config](../../config/Config). Available options: Available options: `"overlay"`, `"reveal"`, `"push"`.
`"overlay"`, `"reveal"`, `"push"`.
## Events ## Events

6
core/src/components/modal/modal.tsx
View File

@ -193,9 +193,6 @@ export class Modal implements OverlayInterface {
* Returns a promise that resolves when the modal did dismiss. It also accepts a callback * Returns a promise that resolves when the modal did dismiss. It also accepts a callback
* that is called in the same circustances. * that is called in the same circustances.
* *
* ```
* const {data, role} = await modal.onDidDismiss();
* ```
*/ */
@Method() @Method()
onDidDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> { onDidDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> {
@ -206,9 +203,6 @@ export class Modal implements OverlayInterface {
* Returns a promise that resolves when the modal will dismiss. It also accepts a callback * Returns a promise that resolves when the modal will dismiss. It also accepts a callback
* that is called in the same circustances. * that is called in the same circustances.
* *
* ```
* const {data, role} = await modal.onWillDismiss();
* ```
*/ */
@Method() @Method()
onWillDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> { onWillDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> {

8
core/src/components/modal/readme.md
View File

@ -240,20 +240,12 @@ Dismiss the modal overlay after it has been presented.
Returns a promise that resolves when the modal did dismiss. It also accepts a callback Returns a promise that resolves when the modal did dismiss. It also accepts a callback
that is called in the same circustances. that is called in the same circustances.
```
const {data, role} = await modal.onDidDismiss();
```
#### onWillDismiss() #### onWillDismiss()
Returns a promise that resolves when the modal will dismiss. It also accepts a callback Returns a promise that resolves when the modal will dismiss. It also accepts a callback
that is called in the same circustances. that is called in the same circustances.
```
const {data, role} = await modal.onWillDismiss();
```
#### present() #### present()

6
core/src/components/picker/picker.tsx
View File

@ -167,9 +167,6 @@ export class Picker implements OverlayInterface {
* Returns a promise that resolves when the picker did dismiss. It also accepts a callback * Returns a promise that resolves when the picker did dismiss. It also accepts a callback
* that is called in the same circustances. * that is called in the same circustances.
* *
* ```
* const {data, role} = await picker.onDidDismiss();
* ```
*/ */
@Method() @Method()
onDidDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> { onDidDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> {
@ -180,9 +177,6 @@ export class Picker implements OverlayInterface {
* Returns a promise that resolves when the picker will dismiss. It also accepts a callback * Returns a promise that resolves when the picker will dismiss. It also accepts a callback
* that is called in the same circustances. * that is called in the same circustances.
* *
* ```
* const {data, role} = await picker.onWillDismiss();
* ```
*/ */
@Method() @Method()
onWillDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> { onWillDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> {

8
core/src/components/picker/readme.md
View File

@ -215,20 +215,12 @@ Dismiss the picker overlay after it has been presented.
Returns a promise that resolves when the picker did dismiss. It also accepts a callback Returns a promise that resolves when the picker did dismiss. It also accepts a callback
that is called in the same circustances. that is called in the same circustances.
```
const {data, role} = await picker.onDidDismiss();
```
#### onWillDismiss() #### onWillDismiss()
Returns a promise that resolves when the picker will dismiss. It also accepts a callback Returns a promise that resolves when the picker will dismiss. It also accepts a callback
that is called in the same circustances. that is called in the same circustances.
```
const {data, role} = await picker.onWillDismiss();
```
#### present() #### present()

6
core/src/components/popover/popover.tsx
View File

@ -203,9 +203,6 @@ export class Popover implements OverlayInterface {
* Returns a promise that resolves when the popover did dismiss. It also accepts a callback * Returns a promise that resolves when the popover did dismiss. It also accepts a callback
* that is called in the same circustances. * that is called in the same circustances.
* *
* ```
* const {data, role} = await popover.onDidDismiss();
* ```
*/ */
@Method() @Method()
onDidDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> { onDidDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> {
@ -216,9 +213,6 @@ export class Popover implements OverlayInterface {
* Returns a promise that resolves when the popover will dismiss. It also accepts a callback * Returns a promise that resolves when the popover will dismiss. It also accepts a callback
* that is called in the same circustances. * that is called in the same circustances.
* *
* ```
* const {data, role} = await popover.onWillDismiss();
* ```
*/ */
@Method() @Method()
onWillDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> { onWillDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> {

8
core/src/components/popover/readme.md
View File

@ -270,20 +270,12 @@ Dismiss the popover overlay after it has been presented.
Returns a promise that resolves when the popover did dismiss. It also accepts a callback Returns a promise that resolves when the popover did dismiss. It also accepts a callback
that is called in the same circustances. that is called in the same circustances.
```
const {data, role} = await popover.onDidDismiss();
```
#### onWillDismiss() #### onWillDismiss()
Returns a promise that resolves when the popover will dismiss. It also accepts a callback Returns a promise that resolves when the popover will dismiss. It also accepts a callback
that is called in the same circustances. that is called in the same circustances.
```
const {data, role} = await popover.onWillDismiss();
```
#### present() #### present()

8
core/src/components/toast/readme.md
View File

@ -230,20 +230,12 @@ Dismiss the toast overlay after it has been presented.
Returns a promise that resolves when the toast did dismiss. It also accepts a callback Returns a promise that resolves when the toast did dismiss. It also accepts a callback
that is called in the same circustances. that is called in the same circustances.
```
const {data, role} = await toast.onDidDismiss();
```
#### onWillDismiss() #### onWillDismiss()
Returns a promise that resolves when the toast will dismiss. It also accepts a callback Returns a promise that resolves when the toast will dismiss. It also accepts a callback
that is called in the same circustances. that is called in the same circustances.
```
const {data, role} = await toast.onWillDismiss();
```
#### present() #### present()

6
core/src/components/toast/toast.tsx
View File

@ -162,9 +162,6 @@ export class Toast implements OverlayInterface {
* Returns a promise that resolves when the toast did dismiss. It also accepts a callback * Returns a promise that resolves when the toast did dismiss. It also accepts a callback
* that is called in the same circustances. * that is called in the same circustances.
* *
* ```
* const {data, role} = await toast.onDidDismiss();
* ```
*/ */
@Method() @Method()
onDidDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> { onDidDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> {
@ -175,9 +172,6 @@ export class Toast implements OverlayInterface {
* Returns a promise that resolves when the toast will dismiss. It also accepts a callback * Returns a promise that resolves when the toast will dismiss. It also accepts a callback
* that is called in the same circustances. * that is called in the same circustances.
* *
* ```
* const {data, role} = await toast.onWillDismiss();
* ```
*/ */
@Method() @Method()
onWillDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> { onWillDismiss(callback?: (detail: OverlayEventDetail) => void): Promise<OverlayEventDetail> {