diff --git a/packages/core/src/components/action-sheet/action-sheet.tsx b/packages/core/src/components/action-sheet/action-sheet.tsx index 95ee9fa7e2..7ae7a4913a 100644 --- a/packages/core/src/components/action-sheet/action-sheet.tsx +++ b/packages/core/src/components/action-sheet/action-sheet.tsx @@ -38,32 +38,32 @@ export class ActionSheet { @Element() private el: HTMLElement; /** - * @output {ActionSheetEvent} Emitted after the alert has loaded. + * Emitted after the alert has loaded. */ @Event() ionActionSheetDidLoad: EventEmitter; /** - * @output {ActionSheetEvent} Emitted after the alert has presented. + * Emitted after the alert has presented. */ @Event() ionActionSheetDidPresent: EventEmitter; /** - * @output {ActionSheetEvent} Emitted before the alert has presented. + * Emitted before the alert has presented. */ @Event() ionActionSheetWillPresent: EventEmitter; /** - * @output {ActionSheetEvent} Emitted before the alert has dismissed. + * Emitted before the alert has dismissed. */ @Event() ionActionSheetWillDismiss: EventEmitter; /** - * @output {ActionSheetEvent} Emitted after the alert has dismissed. + * Emitted after the alert has dismissed. */ @Event() ionActionSheetDidDismiss: EventEmitter; /** - * @output {ActionSheetEvent} Emitted after the alert has unloaded. + * Emitted after the alert has unloaded. */ @Event() ionActionSheetDidUnload: EventEmitter; @@ -151,7 +151,7 @@ export class ActionSheet { } /** - * Dismiss the action-sheet programatically + * Dismiss the action-sheet */ @Method() dismiss(data?: any, role?: string) { diff --git a/packages/core/src/components/action-sheet/readme.md b/packages/core/src/components/action-sheet/readme.md index b214777d78..ba4c7af3dd 100644 --- a/packages/core/src/components/action-sheet/readme.md +++ b/packages/core/src/components/action-sheet/readme.md @@ -139,27 +139,39 @@ Enable action-sheet animations. If false, action-sheet will not animate in #### ionActionSheetDidDismiss +Emitted after the alert has dismissed. + #### ionActionSheetDidLoad +Emitted after the alert has loaded. + #### ionActionSheetDidPresent +Emitted after the alert has presented. + #### ionActionSheetDidUnload +Emitted after the alert has unloaded. + #### ionActionSheetWillDismiss +Emitted before the alert has dismissed. + #### ionActionSheetWillPresent +Emitted before the alert has presented. + ## Methods #### dismiss() -Dismiss the action-sheet programatically +Dismiss the action-sheet #### present() diff --git a/packages/core/src/components/alert/alert.tsx b/packages/core/src/components/alert/alert.tsx index 1ca335232e..8e2ec936c4 100644 --- a/packages/core/src/components/alert/alert.tsx +++ b/packages/core/src/components/alert/alert.tsx @@ -34,32 +34,32 @@ export class Alert { @Element() private el: HTMLElement; /** - * @output {AlertEvent} Emitted after the alert has loaded. + * Emitted after the alert has loaded. */ @Event() ionAlertDidLoad: EventEmitter; /** - * @output {AlertEvent} Emitted after the alert has presented. + * Emitted after the alert has presented. */ @Event() ionAlertDidPresent: EventEmitter; /** - * @output {AlertEvent} Emitted before the alert has presented. + * Emitted before the alert has presented. */ @Event() ionAlertWillPresent: EventEmitter; /** - * @output {AlertEvent} Emitted before the alert has dismissed. + * Emitted before the alert has dismissed. */ @Event() ionAlertWillDismiss: EventEmitter; /** - * @output {AlertEvent} Emitted after the alert has dismissed. + * Emitted after the alert has dismissed. */ @Event() ionAlertDidDismiss: EventEmitter; /** - * @output {AlertEvent} Emitted after the alert has unloaded. + * Emitted after the alert has unloaded. */ @Event() ionAlertDidUnload: EventEmitter; @@ -158,7 +158,7 @@ export class Alert { } /** - * Dismiss the alert programatically + * Dismiss the alert */ @Method() dismiss(data?: any, role?: string) { if (this.animation) { diff --git a/packages/core/src/components/alert/readme.md b/packages/core/src/components/alert/readme.md index 1de51ee93c..c989eb3cce 100644 --- a/packages/core/src/components/alert/readme.md +++ b/packages/core/src/components/alert/readme.md @@ -167,27 +167,39 @@ Enable alert animations. If false, alert will not animate in #### ionAlertDidDismiss +Emitted after the alert has dismissed. + #### ionAlertDidLoad +Emitted after the alert has loaded. + #### ionAlertDidPresent +Emitted after the alert has presented. + #### ionAlertDidUnload +Emitted after the alert has unloaded. + #### ionAlertWillDismiss +Emitted before the alert has dismissed. + #### ionAlertWillPresent +Emitted before the alert has presented. + ## Methods #### dismiss() -Dismiss the alert programatically +Dismiss the alert #### present() diff --git a/packages/core/src/components/app/app.tsx b/packages/core/src/components/app/app.tsx index 0d8e838e84..9188ee0bed 100644 --- a/packages/core/src/components/app/app.tsx +++ b/packages/core/src/components/app/app.tsx @@ -35,7 +35,12 @@ export class App { rootNavs.set((event.detail as Nav).navId, (event.detail as Nav)); } - @Method() getRootNavs(): NavContainer[] { + + /** + * Returns an array of top level Navs + */ + @Method() + getRootNavs(): NavContainer[] { const navs: NavContainer[] = []; rootNavs.forEach((rootNav: NavContainer) => { navs.push(rootNav); @@ -43,6 +48,10 @@ export class App { return navs; } + + /** + * Check if the app is currently scrolling + */ @Method() isScrolling(): boolean { // TODO - sync with Manu return false; diff --git a/packages/core/src/components/app/readme.md b/packages/core/src/components/app/readme.md index e6e9fcede7..b439e4c533 100644 --- a/packages/core/src/components/app/readme.md +++ b/packages/core/src/components/app/readme.md @@ -15,9 +15,13 @@ #### getRootNavs() +Returns an array of top level Navs + #### isScrolling() +Check if the app is currently scrolling + ---------------------------------------------- diff --git a/packages/core/src/components/card-content/card-content.tsx b/packages/core/src/components/card-content/card-content.tsx index 832a74dea8..4d77c34595 100644 --- a/packages/core/src/components/card-content/card-content.tsx +++ b/packages/core/src/components/card-content/card-content.tsx @@ -12,16 +12,14 @@ import { Component, Prop } from '@stencil/core'; }) export class CardContent { /** - * @input {string} The color to use from your Sass `$colors` map. + * The color to use for the text. * Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. - * For more information, see [Theming your App](/docs/theming/theming-your-app). */ @Prop() color: string; /** - * @input {string} The mode determines which platform styles to use. + * 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). */ @Prop() mode: 'ios' | 'md'; diff --git a/packages/core/src/components/card-content/readme.md b/packages/core/src/components/card-content/readme.md index cfd2c3b1ce..02bd522fdf 100644 --- a/packages/core/src/components/card-content/readme.md +++ b/packages/core/src/components/card-content/readme.md @@ -1,5 +1,7 @@ # ion-card-content +`ion-card-content` is child component of `ion-card` that adds some content padding. +It is recommended that any text content for a card should be placed in an `ion-card-content`. @@ -11,11 +13,17 @@ string +The color to use for the text. +Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. + #### mode any +The mode determines which platform styles to use. +Possible values are: `"ios"` or `"md"`. + ## Attributes @@ -23,11 +31,17 @@ any string +The color to use for the text. +Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. + #### mode any +The mode determines which platform styles to use. +Possible values are: `"ios"` or `"md"`. + ---------------------------------------------- diff --git a/packages/core/src/components/card-header/card-header.tsx b/packages/core/src/components/card-header/card-header.tsx index f8d6a8e08c..53946f2a41 100644 --- a/packages/core/src/components/card-header/card-header.tsx +++ b/packages/core/src/components/card-header/card-header.tsx @@ -14,21 +14,19 @@ import { createThemedClasses } from '../../utils/theme'; }) export class CardHeader { /** - * @input {string} The color to use from your Sass `$colors` map. + * The color to use for the background. * Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. - * For more information, see [Theming your App](/docs/theming/theming-your-app). */ @Prop() color: string; /** - * @input {string} The mode determines which platform styles to use. + * 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). */ @Prop() mode: 'ios' | 'md'; /** - * @input {boolean} If true, adds transparency to the card header. + * If true, adds transparency to the card header. * Only affects `ios` mode. Defaults to `false`. */ @Prop() translucent: boolean = false; diff --git a/packages/core/src/components/card-header/readme.md b/packages/core/src/components/card-header/readme.md index 658453bcde..d7dc186917 100644 --- a/packages/core/src/components/card-header/readme.md +++ b/packages/core/src/components/card-header/readme.md @@ -1,6 +1,6 @@ # ion-card-header - +`ion-card-header` is a header component for `ion-card`. @@ -11,16 +11,25 @@ string +The color to use for the background. +Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. + #### mode any +The mode determines which platform styles to use. +Possible values are: `"ios"` or `"md"`. + #### translucent boolean +If true, adds transparency to the card header. +Only affects `ios` mode. Defaults to `false`. + ## Attributes @@ -28,16 +37,25 @@ boolean string +The color to use for the background. +Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. + #### mode any +The mode determines which platform styles to use. +Possible values are: `"ios"` or `"md"`. + #### translucent boolean +If true, adds transparency to the card header. +Only affects `ios` mode. Defaults to `false`. + ---------------------------------------------- diff --git a/packages/core/src/components/card-subtitle/card-subtitle.tsx b/packages/core/src/components/card-subtitle/card-subtitle.tsx index 9882ca9a14..fec6f0f1c0 100644 --- a/packages/core/src/components/card-subtitle/card-subtitle.tsx +++ b/packages/core/src/components/card-subtitle/card-subtitle.tsx @@ -13,16 +13,14 @@ import { Component, Prop} from '@stencil/core'; }) export class CardSubtitle { /** - * @input {string} The color to use from your Sass `$colors` map. + * The color to use for the text color. * Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. - * For more information, see [Theming your App](/docs/theming/theming-your-app). */ @Prop() color: string; /** - * @input {string} The mode determines which platform styles to use. + * 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). */ @Prop() mode: 'ios' | 'md'; diff --git a/packages/core/src/components/card-subtitle/readme.md b/packages/core/src/components/card-subtitle/readme.md index e47a6232fd..93197304a8 100644 --- a/packages/core/src/components/card-subtitle/readme.md +++ b/packages/core/src/components/card-subtitle/readme.md @@ -1,6 +1,6 @@ # ion-card-subtitle - +`ion-card-subtitle` is a child component of `ion-card` @@ -11,11 +11,17 @@ string +The color to use for the text color. +Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. + #### mode any +The mode determines which platform styles to use. +Possible values are: `"ios"` or `"md"`. + ## Attributes @@ -23,11 +29,17 @@ any string +The color to use for the text color. +Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. + #### mode any +The mode determines which platform styles to use. +Possible values are: `"ios"` or `"md"`. + ---------------------------------------------- diff --git a/packages/core/src/components/card-title/card-title.tsx b/packages/core/src/components/card-title/card-title.tsx index 58da107447..0ee498c150 100644 --- a/packages/core/src/components/card-title/card-title.tsx +++ b/packages/core/src/components/card-title/card-title.tsx @@ -12,17 +12,16 @@ import { Component, Prop} from '@stencil/core'; } }) export class CardTitle { + /** - * @input {string} The color to use from your Sass `$colors` map. + * The color to use for the text color. * Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. - * For more information, see [Theming your App](/docs/theming/theming-your-app). */ @Prop() color: string; /** - * @input {string} The mode determines which platform styles to use. + * 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). */ @Prop() mode: 'ios' | 'md'; diff --git a/packages/core/src/components/card-title/readme.md b/packages/core/src/components/card-title/readme.md index 4a6d24cb2e..6cc8a42ccd 100644 --- a/packages/core/src/components/card-title/readme.md +++ b/packages/core/src/components/card-title/readme.md @@ -1,5 +1,6 @@ # ion-card-title +`ion-card-title` is a child component of `ion-card` @@ -11,11 +12,17 @@ string +The color to use for the text color. +Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. + #### mode any +The mode determines which platform styles to use. +Possible values are: `"ios"` or `"md"`. + ## Attributes @@ -23,11 +30,17 @@ any string +The color to use for the text color. +Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. + #### mode any +The mode determines which platform styles to use. +Possible values are: `"ios"` or `"md"`. + ---------------------------------------------- diff --git a/packages/core/src/components/card/card.tsx b/packages/core/src/components/card/card.tsx index 3ce509bc78..2af5644296 100644 --- a/packages/core/src/components/card/card.tsx +++ b/packages/core/src/components/card/card.tsx @@ -11,17 +11,16 @@ import { Component, Prop } from '@stencil/core'; } }) export class Card { + /** - * @input {string} The color to use from your Sass `$colors` map. + * The color to use for the background. * Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. - * For more information, see [Theming your App](/docs/theming/theming-your-app). */ @Prop() color: string; /** - * @input {string} The mode determines which platform styles to use. + * 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). */ @Prop() mode: 'ios' | 'md'; diff --git a/packages/core/src/components/card/readme.md b/packages/core/src/components/card/readme.md index 22ffc44334..456fee3828 100644 --- a/packages/core/src/components/card/readme.md +++ b/packages/core/src/components/card/readme.md @@ -1,6 +1,10 @@ # ion-card - +Cards are a standard piece of UI that serves as an entry point to more detailed +information. A card can be a single component, but is often made up of some +header, title, subtitle, and content. `ion-card` is broken up into several +sub-components to reflect this. Please see `ion-card-content`, +`ion-card-header`, `ion-card-title`, `ion-card-subtitle`. @@ -11,11 +15,17 @@ string +The color to use for the background. +Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. + #### mode any +The mode determines which platform styles to use. +Possible values are: `"ios"` or `"md"`. + ## Attributes @@ -23,11 +33,17 @@ any string +The color to use for the background. +Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. + #### mode any +The mode determines which platform styles to use. +Possible values are: `"ios"` or `"md"`. + ----------------------------------------------