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

chore(): update docs

Browse Source
This commit is contained in:
Manu Mtz.-Almeida
2018-07-24 23:05:35 +02:00
parent 90cb7b1fca
commit b4976dd914
33 changed files with 226 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -505,7 +505,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonAnchor { interface IonAnchor {
/** /**
* The color to use for the anchor. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -539,7 +539,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonAnchorAttributes extends HTMLAttributes { export interface IonAnchorAttributes extends HTMLAttributes {
/** /**
* The color to use for the anchor. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -662,7 +662,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonBackButton { interface IonBackButton {
/** /**
* The color the button should be. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -704,7 +704,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonBackButtonAttributes extends HTMLAttributes { export interface IonBackButtonAttributes extends HTMLAttributes {
/** /**
* The color the button should be. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -792,7 +792,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonBadge { interface IonBadge {
/** /**
* The color the badge should be. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -822,7 +822,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonBadgeAttributes extends HTMLAttributes { export interface IonBadgeAttributes extends HTMLAttributes {
/** /**
* The color the badge should be. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -843,7 +843,7 @@ declare global {
*/ */
'buttonType': string; 'buttonType': string;
/** /**
* The color to use for the button. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -913,7 +913,7 @@ declare global {
*/ */
'buttonType'?: string; 'buttonType'?: string;
/** /**
* The color to use for the button. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -1046,7 +1046,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonCardHeader { interface IonCardHeader {
/** /**
* The color to use for the background. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -1080,7 +1080,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonCardHeaderAttributes extends HTMLAttributes { export interface IonCardHeaderAttributes extends HTMLAttributes {
/** /**
* The color to use for the background. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -1101,7 +1101,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonCardSubtitle { interface IonCardSubtitle {
/** /**
* The color to use for the text color. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -1131,7 +1131,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonCardSubtitleAttributes extends HTMLAttributes { export interface IonCardSubtitleAttributes extends HTMLAttributes {
/** /**
* The color to use for the text color. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -1148,7 +1148,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonCardTitle { interface IonCardTitle {
/** /**
* The color to use for the text color. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -1178,7 +1178,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonCardTitleAttributes extends HTMLAttributes { export interface IonCardTitleAttributes extends HTMLAttributes {
/** /**
* The color to use for the text color. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -1195,7 +1195,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonCard { interface IonCard {
/** /**
* The color to use for the background. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -1225,7 +1225,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonCardAttributes extends HTMLAttributes { export interface IonCardAttributes extends HTMLAttributes {
/** /**
* The color to use for the background. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -1246,7 +1246,7 @@ declare global {
*/ */
'checked': boolean; 'checked': boolean;
/** /**
* The color to use for the checkbox. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -1292,7 +1292,7 @@ declare global {
*/ */
'checked'?: boolean; 'checked'?: boolean;
/** /**
* The color to use for the checkbox. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -1337,7 +1337,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonChipButton { interface IonChipButton {
/** /**
* The color to use. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -1379,7 +1379,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonChipButtonAttributes extends HTMLAttributes { export interface IonChipButtonAttributes extends HTMLAttributes {
/** /**
* The color to use. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -1408,7 +1408,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonChipIcon { interface IonChipIcon {
/** /**
* The color to use. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -1442,7 +1442,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonChipIconAttributes extends HTMLAttributes { export interface IonChipIconAttributes extends HTMLAttributes {
/** /**
* The color to use. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -1463,7 +1463,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonChip { interface IonChip {
/** /**
* The color to use. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -1493,7 +1493,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonChipAttributes extends HTMLAttributes { export interface IonChipAttributes extends HTMLAttributes {
/** /**
* The color to use. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -1994,7 +1994,7 @@ declare global {
*/ */
'activated': boolean; 'activated': boolean;
/** /**
* The color to use for the button. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -2044,7 +2044,7 @@ declare global {
*/ */
'activated'?: boolean; 'activated'?: boolean;
/** /**
* The color to use for the button. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -3023,7 +3023,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonItemDivider { interface IonItemDivider {
/** /**
* The color to use for the item-divider * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -3053,7 +3053,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonItemDividerAttributes extends HTMLAttributes { export interface IonItemDividerAttributes extends HTMLAttributes {
/** /**
* The color to use for the item-divider * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -3103,7 +3103,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonItemOption { interface IonItemOption {
/** /**
* The color to use for the option * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -3145,7 +3145,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonItemOptionAttributes extends HTMLAttributes { export interface IonItemOptionAttributes extends HTMLAttributes {
/** /**
* The color to use for the option * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -3275,7 +3275,7 @@ declare global {
*/ */
'button': boolean; 'button': boolean;
/** /**
* The color to use for the background of the item. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -3338,7 +3338,7 @@ declare global {
*/ */
'button'?: boolean; 'button'?: boolean;
/** /**
* The color to use for the background of the item. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -3384,7 +3384,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonLabel { interface IonLabel {
/** /**
* The color to use for the label's text * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
'getText': () => string; 'getText': () => string;
@ -3419,7 +3419,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonLabelAttributes extends HTMLAttributes { export interface IonLabelAttributes extends HTMLAttributes {
/** /**
* The color to use for the label's text * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -3444,7 +3444,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonListHeader { interface IonListHeader {
/** /**
* The color to use for the background. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -3474,7 +3474,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonListHeaderAttributes extends HTMLAttributes { export interface IonListHeaderAttributes extends HTMLAttributes {
/** /**
* The color to use for the background. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -3767,7 +3767,7 @@ declare global {
*/ */
'autoHide': boolean; 'autoHide': boolean;
/** /**
* The color to use for the background of the item. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -3805,7 +3805,7 @@ declare global {
*/ */
'autoHide'?: boolean; 'autoHide'?: boolean;
/** /**
* The color to use for the background of the item. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -4509,7 +4509,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonNote { interface IonNote {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -4539,7 +4539,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonNoteAttributes extends HTMLAttributes { export interface IonNoteAttributes extends HTMLAttributes {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -4837,7 +4837,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonPopover { interface IonPopover {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -4926,7 +4926,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonPopoverAttributes extends HTMLAttributes { export interface IonPopoverAttributes extends HTMLAttributes {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -5075,7 +5075,7 @@ declare global {
*/ */
'checked': boolean; 'checked': boolean;
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -5121,7 +5121,7 @@ declare global {
*/ */
'checked'?: boolean; 'checked'?: boolean;
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -5225,7 +5225,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonRange { interface IonRange {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -5295,7 +5295,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonRangeAttributes extends HTMLAttributes { export interface IonRangeAttributes extends HTMLAttributes {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -6004,7 +6004,7 @@ declare global {
*/ */
'clearIcon': string; 'clearIcon': string;
/** /**
* The color the searchbar should be. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -6086,7 +6086,7 @@ declare global {
*/ */
'clearIcon'?: string; 'clearIcon'?: string;
/** /**
* The color the searchbar should be. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -6159,7 +6159,7 @@ declare global {
*/ */
'checked': boolean; 'checked': boolean;
/** /**
* The color to use for the text color. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
'disabled': boolean; 'disabled': boolean;
@ -6198,7 +6198,7 @@ declare global {
*/ */
'checked'?: boolean; 'checked'?: boolean;
/** /**
* The color to use for the text color. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
'disabled'?: boolean; 'disabled'?: boolean;
@ -6224,7 +6224,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonSegment { interface IonSegment {
/** /**
* The color to use for the text color. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
'disabled': boolean; 'disabled': boolean;
@ -6259,7 +6259,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonSegmentAttributes extends HTMLAttributes { export interface IonSegmentAttributes extends HTMLAttributes {
/** /**
* The color to use for the text color. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
'disabled'?: boolean; 'disabled'?: boolean;
@ -6856,7 +6856,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonSpinner { interface IonSpinner {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -6898,7 +6898,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonSpinnerAttributes extends HTMLAttributes { export interface IonSpinnerAttributes extends HTMLAttributes {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -7296,7 +7296,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonTabs { interface IonTabs {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
'getRouteId': () => RouteID | undefined; 'getRouteId': () => RouteID | undefined;
@ -7368,7 +7368,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonTabsAttributes extends HTMLAttributes { export interface IonTabsAttributes extends HTMLAttributes {
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -7462,7 +7462,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonText { interface IonText {
/** /**
* The color to use for the text. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -7492,7 +7492,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonTextAttributes extends HTMLAttributes { export interface IonTextAttributes extends HTMLAttributes {
/** /**
* The color to use for the text. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -7729,7 +7729,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonTitle { interface IonTitle {
/** /**
* The color to use for the title. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -7759,7 +7759,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonTitleAttributes extends HTMLAttributes { export interface IonTitleAttributes extends HTMLAttributes {
/** /**
* The color to use for the title. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -7979,7 +7979,7 @@ declare global {
*/ */
'checked': boolean; 'checked': boolean;
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -8025,7 +8025,7 @@ declare global {
*/ */
'checked'?: boolean; 'checked'?: boolean;
/** /**
* The color to use from your Sass `$colors` map. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**
@ -8070,7 +8070,7 @@ declare global {
namespace StencilComponents { namespace StencilComponents {
interface IonToolbar { interface IonToolbar {
/** /**
* The color to use for the background. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color': Color; 'color': Color;
/** /**
@ -8104,7 +8104,7 @@ declare global {
namespace JSXElements { namespace JSXElements {
export interface IonToolbarAttributes extends HTMLAttributes { export interface IonToolbarAttributes extends HTMLAttributes {
/** /**
* The color to use for the background. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics).
*/ */
'color'?: Color; 'color'?: Color;
/** /**

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

@ -12,7 +12,9 @@ The Anchor component is used for navigating to a specified link. Similar to the
string string
The color to use for the anchor. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### href #### href
@ -37,7 +39,9 @@ another page using `href`.
string string
The color to use for the anchor. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### href #### href

8
core/src/components/back-button/readme.md
View File

@ -14,7 +14,9 @@ To change what is displayed in the back button, use the `text` and `icon` proper
string string
The color the button should be. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### defaultHref #### defaultHref
@ -52,7 +54,9 @@ The text to display in the back button.
string string
The color the button should be. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### default-href #### default-href

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

@ -12,7 +12,9 @@ Badges are inline block elements that usually appear near another element. Typic
string string
The color the badge should be. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -29,7 +31,9 @@ Possible values are: `"ios"` or `"md"`.
string string
The color the badge should be. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

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

@ -49,7 +49,9 @@ Possible values are: `"button"`, `"bar-button"`.
string string
The color to use for the button. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled
@ -146,7 +148,9 @@ Possible values are: `"button"`, `"bar-button"`.
string string
The color to use for the button. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled

8
core/src/components/card-header/readme.md
View File

@ -12,7 +12,9 @@
string string
The color to use for the background. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -36,7 +38,9 @@ If true, the card header will be translucent. Defaults to `false`.
string string
The color to use for the background. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

8
core/src/components/card-subtitle/readme.md
View File

@ -11,7 +11,9 @@
string string
The color to use for the text color. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -28,7 +30,9 @@ Possible values are: `"ios"` or `"md"`.
string string
The color to use for the text color. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

8
core/src/components/card-title/readme.md
View File

@ -12,7 +12,9 @@
string string
The color to use for the text color. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -29,7 +31,9 @@ Possible values are: `"ios"` or `"md"`.
string string
The color to use for the text color. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

6
core/src/components/card/readme.md
View File

@ -15,8 +15,9 @@ sub-components to reflect this. Please see `ion-card-content`,
string string
The color to use for the background. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -33,8 +34,9 @@ Possible values are: `"ios"` or `"md"`.
string string
The color to use for the background. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

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

@ -21,7 +21,9 @@ If true, the checkbox is selected. Defaults to `false`.
string string
The color to use for the checkbox. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled
@ -66,7 +68,9 @@ If true, the checkbox is selected. Defaults to `false`.
string string
The color to use for the checkbox. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled

6
core/src/components/chip-button/readme.md
View File

@ -11,8 +11,9 @@ A ChipButton is an inset button that is placed inside of a Chip. For more inform
string string
The color to use. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled
@ -51,8 +52,9 @@ Possible values are: `"ios"` or `"md"`.
string string
The color to use. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled

6
core/src/components/chip-icon/readme.md
View File

@ -11,8 +11,9 @@
string string
The color to use. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -37,8 +38,9 @@ Possible values are the same as `"ion-icon"`.
string string
The color to use. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

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

@ -11,7 +11,9 @@ Chips represent complex entities in small blocks, such as a contact. A chip can
string string
The color to use. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -28,7 +30,9 @@ Possible values are: `"ios"` or `"md"`.
string string
The color to use. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

8
core/src/components/fab-button/readme.md
View File

@ -20,7 +20,9 @@ If true, the fab button will be show a close icon. Defaults to `false`.
string string
The color to use for the button. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled
@ -73,7 +75,9 @@ If true, the fab button will be show a close icon. Defaults to `false`.
string string
The color to use for the button. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled

8
core/src/components/item-divider/readme.md
View File

@ -11,7 +11,9 @@ Item Dividers are block elements that can be used to separate items in a list. T
string string
The color to use for the item-divider The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -28,7 +30,9 @@ Possible values are: `"ios"` or `"md"`.
string string
The color to use for the item-divider The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

8
core/src/components/item-option/readme.md
View File

@ -13,7 +13,9 @@ action for the item.
string string
The color to use for the option The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled
@ -52,7 +54,9 @@ Possible values are: `"ios"` or `"md"`.
string string
The color to use for the option The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled

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

@ -56,7 +56,9 @@ If true, a button tag will be rendered and the item will be tappable. Defaults t
string string
The color to use for the background of the item. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### detail #### detail
@ -139,7 +141,9 @@ If true, a button tag will be rendered and the item will be tappable. Defaults t
string string
The color to use for the background of the item. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### detail #### detail

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

@ -12,7 +12,9 @@ Label is a wrapper element that can be used in combination with `ion-item`, `ion
string string
The color to use for the label's text The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -37,7 +39,9 @@ Possible values are: 'inline' | 'fixed' | 'stacked' | 'floating'
string string
The color to use for the label's text The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

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

@ -13,7 +13,9 @@ Unlike ItemDivider, ListHeaders are styled to be stand-out from the rest of the
string string
The color to use for the background. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -30,7 +32,9 @@ Possible values are: `"ios"` or `"md"`.
string string
The color to use for the background. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

8
core/src/components/menu-button/readme.md
View File

@ -19,7 +19,9 @@ Automatically hides the menu button when the corresponding menu is not active
string string
The color to use for the background of the item. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### menu #### menu
@ -50,7 +52,9 @@ Automatically hides the menu button when the corresponding menu is not active
string string
The color to use for the background of the item. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### menu #### menu

6
core/src/components/note/readme.md
View File

@ -12,8 +12,9 @@ Notes are text elements generally used as subtitles that provide more informatio
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -30,8 +31,9 @@ Possible values are: `"ios"` or `"md"`.
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

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

@ -20,8 +20,9 @@ To present a popover, call the `present` method on a popover instance. In order
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### component #### component
@ -124,8 +125,9 @@ If true, the popover will animate. Defaults to `true`.
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### component #### component

6
core/src/components/radio/readme.md
View File

@ -23,8 +23,9 @@ If true, the radio is selected. Defaults to `false`.
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled
@ -69,8 +70,9 @@ If true, the radio is selected. Defaults to `false`.
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled

6
core/src/components/range/readme.md
View File

@ -21,8 +21,9 @@ left or right of the range.
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### debounce #### debounce
@ -112,8 +113,9 @@ the value of the range.
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### debounce #### debounce

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

@ -57,7 +57,9 @@ Set the clear icon. Defaults to `"close-circle"` for `ios` and `"close"` for `md
string string
The color the searchbar should be. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### debounce #### debounce
@ -165,7 +167,9 @@ Set the clear icon. Defaults to `"close-circle"` for `ios` and `"close"` for `md
string string
The color the searchbar should be. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### debounce #### debounce

6
core/src/components/segment-button/readme.md
View File

@ -19,8 +19,9 @@ If true, the segment button is selected. Defaults to `false`.
string string
The color to use for the text color. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled
@ -56,8 +57,9 @@ If true, the segment button is selected. Defaults to `false`.
string string
The color to use for the text color. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled

6
core/src/components/segment/readme.md
View File

@ -14,8 +14,9 @@ Their functionality is similar to tabs, where selecting one will deselect all ot
string string
The color to use for the text color. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled
@ -44,8 +45,9 @@ the value of the segment.
string string
The color to use for the text color. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled

6
core/src/components/spinner/readme.md
View File

@ -15,8 +15,9 @@ The default spinner to use is based on the platform. The default spinner for `io
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### duration #### duration
@ -56,8 +57,9 @@ If true, the spinner's animation will be paused. Defaults to `false`.
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### duration #### duration

6
core/src/components/tabs/readme.md
View File

@ -13,8 +13,9 @@ The component is a container of individual [Tab](../Tab/) components.
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### name #### name
@ -82,8 +83,9 @@ If true, the tabs will use the router and `selectedTab` will not do anything.
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### name #### name

6
core/src/components/text/readme.md
View File

@ -12,8 +12,9 @@ The text component is a simple component that can be used to style the text colo
string string
The color to use for the text. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -30,8 +31,9 @@ Possible values are: `"ios"` or `"md"`.
string string
The color to use for the text. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

6
core/src/components/title/readme.md
View File

@ -13,8 +13,9 @@
string string
The color to use for the title. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -31,8 +32,9 @@ Possible values are: `"ios"` or `"md"`.
string string
The color to use for the title. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode

6
core/src/components/toggle/readme.md
View File

@ -20,8 +20,9 @@ If true, the toggle is selected. Defaults to `false`.
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled
@ -66,8 +67,9 @@ If true, the toggle is selected. Defaults to `false`.
string string
The color to use from your Sass `$colors` map. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### disabled #### disabled

6
core/src/components/toolbar/readme.md
View File

@ -30,8 +30,9 @@ In `md` mode, the `<ion-header>` will receive a box-shadow on the bottom, and th
string string
The color to use for the background. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode
@ -58,8 +59,9 @@ Defaults to `false`.
string string
The color to use for the background. The color to use from your application's color palette.
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
For more information on colors, see [theming](/docs/theming/basics).
#### mode #### mode