shoelace/src/components/breadcrumb-item/breadcrumb-item.ts

91 wiersze
3.3 KiB
TypeScript
Czysty Zwykły widok Historia

2021-09-29 12:40:26 +00:00
import { classMap } from 'lit/directives/class-map.js';
2023-01-13 20:43:55 +00:00
import { customElement, property } from 'lit/decorators.js';
import { HasSlotController } from '../../internal/slot';
import { html } from 'lit';
2021-09-29 12:40:26 +00:00
import { ifDefined } from 'lit/directives/if-defined.js';
2022-08-17 15:37:37 +00:00
import ShoelaceElement from '../../internal/shoelace-element';
2021-09-01 13:06:19 +00:00
import styles from './breadcrumb-item.styles';
import type { CSSResultGroup } from 'lit';
2021-09-01 13:06:19 +00:00
/**
Enrich components `@summary` with description from docs (#962) * keep header styles with repositioned description text * `animated-image` move description to component * code style * `avatar` add summary from docs * `badge` add summary from docs * `breadcrumb` add summary from docs * `button` add summary from docs * lead sentence is now part of the header * `button-group` add summary from docs * `card` add summary from docs * `checkbox` add summary from docs * `color-picker` add summary from docs * `details` add summary from docs * `dialog` add summary from docs * `divider` add summary from docs * `drawer` add summary from docs * `dropdown` add summary from docs * `format-bytes` add summary from docs * `format-date` add summary from docs * `format-number` add summary from docs * `icon` add summary from docs * `icon-button` add summary from docs * `image-comparer` add summary from docs * `include` add summary from docs * `input` add summary from docs * `menu` add summary from docs * `menu-item` add summary from docs * `menu-label` add summary from docs * `popup` add summary from docs * `progressbar` add summary from docs * `progress-ring` add summary from docs * `radio` add summary from docs * `radio-button` add summary from docs * `range` add summary from docs * `rating` add summary from docs * `relative-time` add summary from docs * `select` add summary from docs * `skeleton` add summary from docs * `spinner` add summary from docs * `split-panel` add summary from docs * `switch` add summary from docs * `tab-group` add summary from docs * `tag` add summary from docs * `textarea` add summary from docs * `tooltip` add summary from docs * `visually-hidden` add summary from docs * `animation` add summary from docs * `breadcrumb-item` add summary from docs * `mutation-observer` add summary from docs * `radio-group` add summary from docs * `resize-observer` add summary from docs * `tab` add summary from docs * `tab-panel` add summary from docs * `tree` add summary from docs * `tree-item` add summary from docs * remove `title` for further usage of `Sl` classnames in docs * revert: use markdown parser for component summary
2022-10-21 13:56:35 +00:00
* @summary Breadcrumb Items are used inside [breadcrumbs](/components/breadcrumb) to represent different links.
2023-01-12 15:26:25 +00:00
* @documentation https://shoelace.style/components/breadcrumb-item
2021-09-01 13:06:19 +00:00
* @status stable
2023-01-12 15:26:25 +00:00
* @since 2.0
2021-09-01 13:06:19 +00:00
*
* @slot - The breadcrumb item's label.
* @slot prefix - An optional prefix, usually an icon or icon button.
* @slot suffix - An optional suffix, usually an icon or icon button.
* @slot separator - The separator to use for the breadcrumb item. This will only change the separator for this item. If
* you want to change it for all items in the group, set the separator on `<sl-breadcrumb>` instead.
*
2022-12-06 16:18:14 +00:00
* @csspart base - The component's base wrapper.
2021-09-01 13:06:19 +00:00
* @csspart label - The breadcrumb item's label.
2022-12-06 16:18:14 +00:00
* @csspart prefix - The container that wraps the prefix.
* @csspart suffix - The container that wraps the suffix.
* @csspart separator - The container that wraps the separator.
2021-09-01 13:06:19 +00:00
*/
@customElement('sl-breadcrumb-item')
2022-08-17 15:37:37 +00:00
export default class SlBreadcrumbItem extends ShoelaceElement {
static styles: CSSResultGroup = styles;
2021-09-01 13:06:19 +00:00
private readonly hasSlotController = new HasSlotController(this, 'prefix', 'suffix');
2021-09-01 13:06:19 +00:00
2021-10-12 14:26:26 +00:00
/**
* 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;
2021-09-01 13:06:19 +00:00
/** Tells the browser where to open the link. Only used when `href` is set. */
@property() target?: '_blank' | '_parent' | '_self' | '_top';
2021-09-01 13:06:19 +00:00
2021-10-12 14:26:26 +00:00
/** The `rel` attribute to use on the link. Only used when `href` is set. */
@property() rel = 'noreferrer noopener';
2021-09-01 13:06:19 +00:00
render() {
2022-01-19 14:37:07 +00:00
const isLink = this.href ? true : false;
2021-09-01 13:06:19 +00:00
return html`
<div
part="base"
class=${classMap({
'breadcrumb-item': true,
'breadcrumb-item--has-prefix': this.hasSlotController.test('prefix'),
'breadcrumb-item--has-suffix': this.hasSlotController.test('suffix')
2021-09-01 13:06:19 +00:00
})}
>
2022-12-02 22:03:59 +00:00
<slot name="prefix" part="prefix" class="breadcrumb-item__prefix"></slot>
2021-09-01 13:06:19 +00:00
${isLink
? html`
<a
part="label"
class="breadcrumb-item__label breadcrumb-item__label--link"
2022-01-19 14:37:07 +00:00
href="${this.href!}"
target="${ifDefined(this.target ? this.target : undefined)}"
rel=${ifDefined(this.target ? this.rel : undefined)}
2021-09-01 13:06:19 +00:00
>
<slot></slot>
</a>
`
: html`
<button part="label" type="button" class="breadcrumb-item__label breadcrumb-item__label--button">
<slot></slot>
</button>
`}
2022-12-02 22:03:59 +00:00
<slot name="suffix" part="suffix" class="breadcrumb-item__suffix"></slot>
2021-09-01 13:06:19 +00:00
2022-12-02 22:03:59 +00:00
<slot name="separator" part="separator" class="breadcrumb-item__separator" aria-hidden="true"></slot>
2021-09-01 13:06:19 +00:00
</div>
`;
}
}
declare global {
interface HTMLElementTagNameMap {
'sl-breadcrumb-item': SlBreadcrumbItem;
}
}