mdui
Version:
实现 material you 设计规范的 Web Components 组件库
68 lines (67 loc) • 2.79 kB
TypeScript
import { LayoutItemBase } from '../layout/layout-item-base.js';
import type { LayoutPlacement } from '../layout/helper.js';
import type { ScrollPaddingPosition } from '@mdui/shared/mixins/scrollBehavior.js';
import type { CSSResultGroup, PropertyValues, TemplateResult } from 'lit';
declare const BottomAppBar_base: import("@lit/reactive-element/decorators/base.js").Constructor<import("@mdui/shared/mixins/scrollBehavior.js").ScrollBehaviorMixinInterface> & typeof LayoutItemBase;
/**
* @summary 底部应用栏组件
*
* ```html
* <mdui-bottom-app-bar>
* ..<mdui-button-icon icon="check_box--outlined"></mdui-button-icon>
* ..<mdui-button-icon icon="edit--outlined"></mdui-button-icon>
* ..<mdui-button-icon icon="mic_none--outlined"></mdui-button-icon>
* ..<mdui-button-icon icon="image--outlined"></mdui-button-icon>
* ..<div style="flex-grow: 1"></div>
* ..<mdui-fab icon="add"></mdui-fab>
* </mdui-bottom-app-bar>
* ```
*
* @event show - 开始显示时，事件被触发。可以通过调用 `event.preventDefault()` 阻止显示
* @event shown - 显示动画完成时，事件被触发
* @event hide - 开始隐藏时，事件被触发。可以通过调用 `event.preventDefault()` 阻止隐藏
* @event hidden - 隐藏动画完成时，事件被触发
*
* @slot - 底部应用栏内部的元素
*
* @cssprop --shape-corner - 组件的圆角大小。可以指定一个具体的像素值；但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
* @cssprop --z-index - 组件的 CSS `z-index` 值
*/
export declare class BottomAppBar extends BottomAppBar_base<BottomAppBarEventMap> {
static styles: CSSResultGroup;
/**
* 是否隐藏
*/
hide: boolean;
/**
* 是否让底部应用栏中的 [`<mdui-fab>`](/docs/2/components/fab) 组件脱离应用栏。如果为 `true`，则当应用栏隐藏后，[`<mdui-fab>`](/docs/2/components/fab) 仍会停留在页面上
*/
fabDetach: boolean;
/**
* 滚动行为。可选值为：
*
* * `hide`：滚动时隐藏
*/
scrollBehavior?: 'hide';
protected get scrollPaddingPosition(): ScrollPaddingPosition;
protected get layoutPlacement(): LayoutPlacement;
protected firstUpdated(_changedProperties: PropertyValues): void;
protected render(): TemplateResult;
/**
* 滚动行为
* 当前仅支持 hide 这一个行为，所以不做行为类型判断
*/
protected runScrollThreshold(isScrollingUp: boolean): void;
}
export interface BottomAppBarEventMap {
show: CustomEvent<void>;
shown: CustomEvent<void>;
hide: CustomEvent<void>;
hidden: CustomEvent<void>;
}
declare global {
interface HTMLElementTagNameMap {
'mdui-bottom-app-bar': BottomAppBar;
}
}
export {};