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

docs(back-button): update icon prop to include src and name approach (#24307)

Browse Source
This commit is contained in:
Sean Perkins
2021-12-03 12:52:42 -05:00
committed by GitHub
parent 047d3c7772
commit f7bd4c02c3
3 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -176,7 +176,7 @@ export namespace Components {
*/ */
"disabled": boolean; "disabled": boolean;
/** /**
* The icon name to use for the back button. * The built-in named SVG icon name or the exact `src` of an SVG file to use for the back button.
*/ */
"icon"?: string | null; "icon"?: string | null;
/** /**
@ -3511,7 +3511,7 @@ declare namespace LocalJSX {
*/ */
"disabled"?: boolean; "disabled"?: boolean;
/** /**
* The icon name to use for the back button. * The built-in named SVG icon name or the exact `src` of an SVG file to use for the back button.
*/ */
"icon"?: string | null; "icon"?: string | null;
/** /**

3
core/src/components/back-button/back-button.tsx
View File

@ -45,7 +45,8 @@ export class BackButton implements ComponentInterface, ButtonInterface {
@Prop({ reflect: true }) disabled = false; @Prop({ reflect: true }) disabled = false;
/** /**
* The icon name to use for the back button. * The built-in named SVG icon name or the exact `src` of an SVG file
* to use for the back button.
*/ */
@Prop() icon?: string | null; @Prop() icon?: string | null;

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

@ -315,7 +315,7 @@ export default defineComponent({
| `color` | `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). | `string \| undefined` | `undefined` | | `color` | `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). | `string \| undefined` | `undefined` |
| `defaultHref` | `default-href` | The url to navigate back to by default when there is no history. | `string \| undefined` | `undefined` | | `defaultHref` | `default-href` | The url to navigate back to by default when there is no history. | `string \| undefined` | `undefined` |
| `disabled` | `disabled` | If `true`, the user cannot interact with the button. | `boolean` | `false` | | `disabled` | `disabled` | If `true`, the user cannot interact with the button. | `boolean` | `false` |
| `icon` | `icon` | The icon name to use for the back button. | `null \| string \| undefined` | `undefined` | | `icon` | `icon` | The built-in named SVG icon name or the exact `src` of an SVG file to use for the back button. | `null \| string \| undefined` | `undefined` |
| `mode` | `mode` | The mode determines which platform styles to use. | `"ios" \| "md"` | `undefined` | | `mode` | `mode` | The mode determines which platform styles to use. | `"ios" \| "md"` | `undefined` |
| `routerAnimation` | -- | When using a router, it specifies the transition animation when navigating to another page. | `((baseEl: any, opts?: any) => Animation) \| undefined` | `undefined` | | `routerAnimation` | -- | When using a router, it specifies the transition animation when navigating to another page. | `((baseEl: any, opts?: any) => Animation) \| undefined` | `undefined` |
| `text` | `text` | The text to display in the back button. | `null \| string \| undefined` | `undefined` | | `text` | `text` | The text to display in the back button. | `null \| string \| undefined` | `undefined` |