mdui
Version:
实现 material you 设计规范的 Web Components 组件库
239 lines (238 loc) • 8.93 kB
JavaScript
import { __decorate } from "tslib";
import { html } from 'lit';
import { customElement, property, queryAssignedElements, state, } from 'lit/decorators.js';
import { when } from 'lit/directives/when.js';
import { $ } from '@mdui/jq/$.js';
import '@mdui/jq/methods/css.js';
import '@mdui/jq/methods/innerWidth.js';
import { DefinedController } from '@mdui/shared/controllers/defined.js';
import { HasSlotController } from '@mdui/shared/controllers/has-slot.js';
import { watch } from '@mdui/shared/decorators/watch.js';
import { booleanConverter } from '@mdui/shared/helpers/decorator.js';
import { componentStyle } from '@mdui/shared/lit-styles/component-style.js';
import { LayoutItemBase } from '../layout/layout-item-base.js';
import { navigationRailStyle } from './navigation-rail-style.js';
/**
* @summary 侧边导航栏组件。需配合 `<mdui-navigation-rail-item>` 组件使用
*
* ```html
* <mdui-navigation-rail>
* ..<mdui-navigation-rail-item icon="watch_later">Recent</mdui-navigation-rail-item>
* ..<mdui-navigation-rail-item icon="image">Images</mdui-navigation-rail-item>
* ..<mdui-navigation-rail-item icon="library_music">Library</mdui-navigation-rail-item>
* </mdui-navigation-rail>
* ```
*
* @event change - 值变化时触发
*
* @slot - `<mdui-navigation-rail-item>` 组件
* @slot top - 顶部的元素
* @slot bottom - 底部的元素
*
* @csspart top - 顶部元素的容器
* @csspart bottom - 底部元素的容器
* @csspart items - `<mdui-navigation-rail-item>` 组件的容器
*
* @cssprop --shape-corner - 组件的圆角大小。可以指定一个具体的像素值；但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
* @cssprop --z-index - 组件的 CSS `z-index` 值
*/
let NavigationRail = class NavigationRail extends LayoutItemBase {
constructor() {
super(...arguments);
/**
* 导航栏的位置。可选值包括：
*
* * `left`：左侧
* * `right`：右侧
*/
this.placement = 'left';
/**
* `<mdui-navigation-rail-item>` 元素的对齐方式。可选值包括：
*
* * `start`：顶部对齐
* * `center`：居中对齐
* * `end`：底部对齐
*/
this.alignment = 'start';
/**
* 默认情况下，导航栏相对于 `body` 元素显示。当该参数设置为 `true` 时，导航栏将相对于其父元素显示。
*
* **Note**：设置该属性时，必须在父元素上手动设置样式 `position: relative;`。
*/
this.contained = false;
/**
* 是否在导航栏和页面内容之间添加分割线
*/
this.divider = false;
// 因为 navigation-rail-item 的 value 可能会重复，所以在每个 navigation-rail-item 元素上都添加了一个唯一的 key，通过 activeKey 来记录激活状态的 key
this.activeKey = 0;
this.hasSlotController = new HasSlotController(this, 'top', 'bottom');
this.definedController = new DefinedController(this, {
relatedElements: ['mdui-navigation-rail-item'],
});
// 是否是初始状态，初始状态不触发事件，不执行动画
this.isInitial = true;
}
get layoutPlacement() {
return this.placement;
}
get parentTarget() {
return this.contained || this.isParentLayout
? this.parentElement
: document.body;
}
get isRight() {
return this.placement === 'right';
}
get paddingValue() {
return ['fixed', 'absolute'].includes($(this).css('position'))
? this.offsetWidth
: undefined;
}
async onActiveKeyChange() {
await this.definedController.whenDefined();
// 根据 activeKey 读取对应 navigation-rail-item 的值
const item = this.items.find((item) => item.key === this.activeKey);
this.value = item?.value;
if (!this.isInitial) {
this.emit('change');
}
}
async onValueChange() {
this.isInitial = !this.hasUpdated;
await this.definedController.whenDefined();
const item = this.items.find((item) => item.value === this.value);
this.activeKey = item?.key ?? 0;
this.updateItems();
}
async onContainedChange() {
if (this.isParentLayout) {
return;
}
await this.definedController.whenDefined();
$(document.body).css({
paddingLeft: this.contained || this.isRight ? null : this.paddingValue,
paddingRight: this.contained || !this.isRight ? null : this.paddingValue,
});
$(this.parentElement).css({
paddingLeft: this.contained && !this.isRight ? this.paddingValue : null,
paddingRight: this.contained && this.isRight ? this.paddingValue : null,
});
}
async onPlacementChange() {
await this.definedController.whenDefined();
this.layoutManager?.updateLayout(this);
this.items.forEach((item) => {
item.placement = this.placement;
});
if (!this.isParentLayout) {
$(this.parentTarget).css({
paddingLeft: this.isRight ? null : this.paddingValue,
paddingRight: this.isRight ? this.paddingValue : null,
});
}
}
connectedCallback() {
super.connectedCallback();
if (!this.isParentLayout) {
this.definedController.whenDefined().then(() => {
$(this.parentTarget).css({
paddingLeft: this.isRight ? null : this.paddingValue,
paddingRight: this.isRight ? this.paddingValue : null,
});
});
}
}
disconnectedCallback() {
super.disconnectedCallback();
if (!this.isParentLayout && this.definedController.isDefined()) {
$(this.parentTarget).css({
paddingLeft: this.isRight ? undefined : null,
paddingRight: this.isRight ? null : undefined,
});
}
}
render() {
const hasTopSlot = this.hasSlotController.test('top');
const hasBottomSlot = this.hasSlotController.test('bottom');
return html `${when(hasTopSlot, () => html `<slot name="top" part="top" class="top"></slot>`)} <span class="top-spacer"></span><slot part="items" class="items" ="${this.onSlotChange}" ="${this.onClick}"></slot><span class="bottom-spacer"></span> ${when(hasBottomSlot, () => html `<slot name="bottom" part="bottom" class="bottom"></slot>`)}`;
}
onClick(event) {
// event.button 为 0 时，为鼠标左键点击。忽略鼠标中键和右键
if (event.button) {
return;
}
const target = event.target;
const item = target.closest('mdui-navigation-rail-item');
if (!item) {
return;
}
this.activeKey = item.key;
this.isInitial = false;
this.updateItems();
}
updateItems() {
this.items.forEach((item) => {
item.active = this.activeKey === item.key;
item.placement = this.placement;
item.isInitial = this.isInitial;
});
}
async onSlotChange() {
await this.definedController.whenDefined();
this.updateItems();
}
};
NavigationRail.styles = [
componentStyle,
navigationRailStyle,
];
__decorate([
property({ reflect: true })
], NavigationRail.prototype, "value", void 0);
__decorate([
property({ reflect: true })
// eslint-disable-next-line prettier/prettier
], NavigationRail.prototype, "placement", void 0);
__decorate([
property({ reflect: true })
], NavigationRail.prototype, "alignment", void 0);
__decorate([
property({
type: Boolean,
reflect: true,
converter: booleanConverter,
})
], NavigationRail.prototype, "contained", void 0);
__decorate([
property({
type: Boolean,
reflect: true,
converter: booleanConverter,
})
], NavigationRail.prototype, "divider", void 0);
__decorate([
state()
], NavigationRail.prototype, "activeKey", void 0);
__decorate([
queryAssignedElements({
selector: 'mdui-navigation-rail-item',
flatten: true,
})
], NavigationRail.prototype, "items", void 0);
__decorate([
watch('activeKey', true)
], NavigationRail.prototype, "onActiveKeyChange", null);
__decorate([
watch('value')
], NavigationRail.prototype, "onValueChange", null);
__decorate([
watch('contained', true)
], NavigationRail.prototype, "onContainedChange", null);
__decorate([
watch('placement', true)
], NavigationRail.prototype, "onPlacementChange", null);
NavigationRail = __decorate([
customElement('mdui-navigation-rail')
], NavigationRail);
export { NavigationRail };