docs(components): update color documentation

This commit is contained in:
Brandy Carney
2018-07-24 11:59:32 -04:00
parent 05b258c6ef
commit f0c15384a2
32 changed files with 82 additions and 34 deletions

View File

@ -13,7 +13,9 @@ export class Anchor {
@Prop({ context: 'window' }) win!: Window;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -18,7 +18,9 @@ export class BackButton {
@Prop({ context: 'window' }) win!: Window;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -12,7 +12,9 @@ import { createColorClasses } from '../../utils/theme';
})
export class Badge {
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -19,7 +19,9 @@ export class Button {
@State() keyFocus = false;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -12,7 +12,9 @@ import { createColorClasses } from '../../utils/theme';
})
export class CardHeader {
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -12,7 +12,9 @@ import { createColorClasses } from '../../utils/theme';
})
export class CardSubtitle {
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -12,7 +12,9 @@ import { createColorClasses } from '../../utils/theme';
})
export class CardTitle {
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -13,8 +13,9 @@ import { createColorClasses } from '../../utils/theme';
export class Card {
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -22,7 +22,9 @@ export class Checkbox implements CheckboxInput {
@State() keyFocus = false;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -11,8 +11,9 @@ export class ChipButton {
@Element() el!: HTMLElement;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -9,8 +9,9 @@ import { createColorClasses } from '../../utils/theme';
})
export class ChipIcon {
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -13,7 +13,9 @@ import { createColorClasses } from '../../utils/theme';
})
export class Chip {
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -16,7 +16,9 @@ export class FabButton {
@Element() el!: HTMLElement;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -15,7 +15,9 @@ export class ItemDivider {
@Element() el!: HTMLElement;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -15,7 +15,9 @@ export class ItemOption {
@Element() el!: HTMLElement;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -15,11 +15,12 @@ export class Item {
@Element() el!: HTMLStencilElement;
@Prop({ context: 'window' })
win!: Window;
@Prop({ context: 'window' }) win!: Window;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -14,7 +14,9 @@ export class Label {
@Element() el!: HTMLElement;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -12,7 +12,9 @@ import { createColorClasses } from '../../utils/theme';
})
export class ListHeader {
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -14,7 +14,9 @@ export class MenuButton {
@Prop({ context: 'config' }) config!: Config;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -12,8 +12,9 @@ import { createColorClasses } from '../../utils/theme';
})
export class Note {
/**
* 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"`.
* For more information on theming colors, see [theming](/docs/theming/basics).
*/
@Prop() color?: Color;

View File

@ -34,8 +34,9 @@ export class Popover implements OverlayInterface {
@Prop() keyboardClose = true;
/**
* 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"`.
* For more information on colors, see [theming](/docs/theming/basics).
*/
@Prop() color?: Color;

View File

@ -22,8 +22,9 @@ export class Radio implements RadioButtonInput {
@Element() el!: HTMLElement;
/**
* 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"`.
* For more information on colors, see [theming](/docs/theming/basics).
*/
@Prop() color?: Color;

View File

@ -26,8 +26,9 @@ export class Range implements BaseInput {
@State() private pressedKnob: Knob;
/**
* 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"`.
* For more information on colors, see [theming](/docs/theming/basics).
*/
@Prop() color?: Color;

View File

@ -28,7 +28,9 @@ export class Searchbar {
@State() focused = false;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -14,8 +14,9 @@ export class SegmentButton {
@Element() el!: HTMLElement;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -16,8 +16,9 @@ export class Segment {
@Element() el!: HTMLElement;
/**
* 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).
*/
@Prop() color?: Color;

View File

@ -16,8 +16,9 @@ export class Spinner {
@Prop({ context: 'config' }) config!: Config;
/**
* 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"`.
* For more information on colors, see [theming](/docs/theming/basics).
*/
@Prop() color?: Color;

View File

@ -25,8 +25,9 @@ export class Tabs implements NavOutlet {
@Prop({ context: 'document' }) doc!: Document;
/**
* 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"`.
* For more information on colors, see [theming](/docs/theming/basics).
*/
@Prop() color?: Color;

View File

@ -11,8 +11,9 @@ import { createColorClasses } from '../../utils/theme';
export class Text {
/**
* 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"`.
* For more information on colors, see [theming](/docs/theming/basics).
*/
@Prop() color?: Color;

View File

@ -15,8 +15,9 @@ export class ToolbarTitle {
@Prop() mode!: Mode;
/**
* 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"`.
* For more information on colors, see [theming](/docs/theming/basics).
*/
@Prop() color?: Color;

View File

@ -25,8 +25,9 @@ export class Toggle implements CheckboxInput {
@State() keyFocus = false;
/**
* 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"`.
* For more information on colors, see [theming](/docs/theming/basics).
*/
@Prop() color?: Color;

View File

@ -15,8 +15,9 @@ export class Toolbar {
@Prop({ context: 'config' }) config!: Config;
/**
* 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).
*/
@Prop() color?: Color;