From d2c94321f26c1e25c34904793b5f70ca301abe00 Mon Sep 17 00:00:00 2001 From: Cory LaViska Date: Tue, 12 Oct 2021 10:26:26 -0400 Subject: [PATCH] update docs --- src/components/breadcrumb-item/breadcrumb-item.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/components/breadcrumb-item/breadcrumb-item.ts b/src/components/breadcrumb-item/breadcrumb-item.ts index 2aed4a423..55a911a63 100644 --- a/src/components/breadcrumb-item/breadcrumb-item.ts +++ b/src/components/breadcrumb-item/breadcrumb-item.ts @@ -28,15 +28,16 @@ export default class SlBreadcrumbItem extends LitElement { @state() hasPrefix = false; @state() hasSuffix = false; - /** Optional link to direct the user to when the breadcrumb item is activated. */ + /** + * Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered + * internally. When unset, a button will be rendered instead. + */ @property() href: string; /** Tells the browser where to open the link. Only used when `href` is set. */ @property() target: '_blank' | '_parent' | '_self' | '_top'; - /** Optionally allows the user to determine how the link should talk to the browser. - * ref: https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types - */ + /** The `rel` attribute to use on the link. Only used when `href` is set. */ @property() rel: string = 'noreferrer noopener'; handleSlotChange() {