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

docs(button): update docs for properties to describe options better (#25940)

Browse Source
This commit is contained in:
Brandy Carney
2022-09-14 17:55:24 -04:00
committed by GitHub
parent 5f1346ef39
commit 0855f8dc79
2 changed files with 18 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -372,11 +372,11 @@ export namespace Components {
*/ */
"download": string | undefined; "download": string | undefined;
/** /**
* Set to `"block"` for a full-width button or to `"full"` for a full-width button without left and right borders. * Set to `"block"` for a full-width button or to `"full"` for a full-width button with square corners and no left or right borders.
*/ */
"expand"?: 'full' | 'block'; "expand"?: 'full' | 'block';
/** /**
* Set to `"clear"` for a transparent button, to `"outline"` for a transparent button with a border, or to `"solid"`. The default style is `"solid"` except inside of a toolbar, where the default is `"clear"`. * Set to `"clear"` for a transparent button that resembles a flat button, to `"outline"` for a transparent button with a border, or to `"solid"` for a button with a filled background. The default fill is `"solid"` except inside of a toolbar, where the default is `"clear"`.
*/ */
"fill"?: 'clear' | 'outline' | 'solid' | 'default'; "fill"?: 'clear' | 'outline' | 'solid' | 'default';
/** /**
@ -400,11 +400,11 @@ export namespace Components {
*/ */
"routerDirection": RouterDirection; "routerDirection": RouterDirection;
/** /**
* The button shape. * Set to `"round"` for a button with more rounded corners.
*/ */
"shape"?: 'round'; "shape"?: 'round';
/** /**
* The button size. * Set to `"small"` for a button with less height and padding, to `"default"` for a button with the default height and padding, or to `"large"` for a button with more height and padding. By default the size is unset, unless the button is inside of an item, where the size is `"small"` by default. Set the size to `"default"` inside of an item to make it a standard size button.
*/ */
"size"?: 'small' | 'default' | 'large'; "size"?: 'small' | 'default' | 'large';
/** /**
@ -4332,11 +4332,11 @@ declare namespace LocalJSX {
*/ */
"download"?: string | undefined; "download"?: string | undefined;
/** /**
* Set to `"block"` for a full-width button or to `"full"` for a full-width button without left and right borders. * Set to `"block"` for a full-width button or to `"full"` for a full-width button with square corners and no left or right borders.
*/ */
"expand"?: 'full' | 'block'; "expand"?: 'full' | 'block';
/** /**
* Set to `"clear"` for a transparent button, to `"outline"` for a transparent button with a border, or to `"solid"`. The default style is `"solid"` except inside of a toolbar, where the default is `"clear"`. * Set to `"clear"` for a transparent button that resembles a flat button, to `"outline"` for a transparent button with a border, or to `"solid"` for a button with a filled background. The default fill is `"solid"` except inside of a toolbar, where the default is `"clear"`.
*/ */
"fill"?: 'clear' | 'outline' | 'solid' | 'default'; "fill"?: 'clear' | 'outline' | 'solid' | 'default';
/** /**
@ -4368,11 +4368,11 @@ declare namespace LocalJSX {
*/ */
"routerDirection"?: RouterDirection; "routerDirection"?: RouterDirection;
/** /**
* The button shape. * Set to `"round"` for a button with more rounded corners.
*/ */
"shape"?: 'round'; "shape"?: 'round';
/** /**
* The button size. * Set to `"small"` for a button with less height and padding, to `"default"` for a button with the default height and padding, or to `"large"` for a button with more height and padding. By default the size is unset, unless the button is inside of an item, where the size is `"small"` by default. Set the size to `"default"` inside of an item to make it a standard size button.
*/ */
"size"?: 'small' | 'default' | 'large'; "size"?: 'small' | 'default' | 'large';
/** /**

16
core/src/components/button/button.tsx
View File

@ -53,14 +53,14 @@ export class Button implements ComponentInterface, AnchorInterface, ButtonInterf
/** /**
* Set to `"block"` for a full-width button or to `"full"` for a full-width button * Set to `"block"` for a full-width button or to `"full"` for a full-width button
* without left and right borders. * with square corners and no left or right borders.
*/ */
@Prop({ reflect: true }) expand?: 'full' | 'block'; @Prop({ reflect: true }) expand?: 'full' | 'block';
/** /**
* Set to `"clear"` for a transparent button, to `"outline"` for a transparent * Set to `"clear"` for a transparent button that resembles a flat button, to `"outline"`
* button with a border, or to `"solid"`. The default style is `"solid"` except inside of * for a transparent button with a border, or to `"solid"` for a button with a filled background.
* a toolbar, where the default is `"clear"`. * The default fill is `"solid"` except inside of a toolbar, where the default is `"clear"`.
*/ */
@Prop({ reflect: true, mutable: true }) fill?: 'clear' | 'outline' | 'solid' | 'default'; @Prop({ reflect: true, mutable: true }) fill?: 'clear' | 'outline' | 'solid' | 'default';
@ -97,12 +97,16 @@ export class Button implements ComponentInterface, AnchorInterface, ButtonInterf
@Prop() rel: string | undefined; @Prop() rel: string | undefined;
/** /**
* The button shape. * Set to `"round"` for a button with more rounded corners.
*/ */
@Prop({ reflect: true }) shape?: 'round'; @Prop({ reflect: true }) shape?: 'round';
/** /**
* The button size. * Set to `"small"` for a button with less height and padding, to `"default"`
* for a button with the default height and padding, or to `"large"` for a button
* with more height and padding. By default the size is unset, unless the button
* is inside of an item, where the size is `"small"` by default. Set the size to
* `"default"` inside of an item to make it a standard size button.
*/ */
@Prop({ reflect: true }) size?: 'small' | 'default' | 'large'; @Prop({ reflect: true }) size?: 'small' | 'default' | 'large';