From f7bd4c02c331f567241d545de8e2ebe4a8dc1d45 Mon Sep 17 00:00:00 2001 From: Sean Perkins Date: Fri, 3 Dec 2021 12:52:42 -0500 Subject: [PATCH] docs(back-button): update icon prop to include src and name approach (#24307) --- core/src/components.d.ts | 4 ++-- core/src/components/back-button/back-button.tsx | 3 ++- core/src/components/back-button/readme.md | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/core/src/components.d.ts b/core/src/components.d.ts index 3d54823801..6c296514b3 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -176,7 +176,7 @@ export namespace Components { */ "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; /** @@ -3511,7 +3511,7 @@ declare namespace LocalJSX { */ "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; /** diff --git a/core/src/components/back-button/back-button.tsx b/core/src/components/back-button/back-button.tsx index ea66e2736c..3942241b2c 100644 --- a/core/src/components/back-button/back-button.tsx +++ b/core/src/components/back-button/back-button.tsx @@ -45,7 +45,8 @@ export class BackButton implements ComponentInterface, ButtonInterface { @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; diff --git a/core/src/components/back-button/readme.md b/core/src/components/back-button/readme.md index ba55f5174b..9c2433d675 100644 --- a/core/src/components/back-button/readme.md +++ b/core/src/components/back-button/readme.md @@ -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` | | `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` | -| `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` | | `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` |