diff --git a/src/components/button/README.md b/src/components/button/README.md new file mode 100644 index 000000000000..131c93f96502 --- /dev/null +++ b/src/components/button/README.md @@ -0,0 +1,99 @@ +# md-button + +`md-button` is an HTML ` + + + + ``` + +Output: + + + +### Theming + +All button types can be themed to match your "primary" palette, your "accent" palette, or your "warn" palette using the `color` attribute. +Simply pass in the palette name. + +In flat buttons, the palette chosen will affect the text color, while in other buttons, it affects the background. + +Example: + + ```html + + + + ``` + +Output: + + + +### Disabling + +You can disable any button type through the native `disabled` property. You can add it directly, or bind it to a property on your +component class. + +```html + + + +``` + +Output: + + + +### Accessibility + + * In high contrast mode, a strong border is added to the button to make it easier to see. + * Button focus events originating from the keyboard will retain focus styles, while button focus events from the mouse will not. + * As `md-button` is added to an existing `button` or `a` tag, it enjoys all the accessibility natively built into these elements. + + +### Upcoming work + +We will also be adding ink ripples to buttons in an upcoming milestone. + +### API Summary + +Properties: + +| Name | Type | Description | +| --- | --- | --- | +| `color` | `"primary"|"accent"|"warn"` | The color palette of the button +| `disabled` | boolean | Whether or not the button is disabled \ No newline at end of file