mdui 2.0.3 → 2.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/components/avatar/index.d.ts +13 -13
  2. package/components/avatar/index.js +4 -4
  3. package/components/badge/index.d.ts +7 -6
  4. package/components/badge/index.js +6 -5
  5. package/components/bottom-app-bar/index.d.ts +4 -3
  6. package/components/bottom-app-bar/index.js +3 -3
  7. package/components/button/button-base-style.js +1 -1
  8. package/components/button/button-base.d.ts +43 -44
  9. package/components/button/button-base.js +20 -20
  10. package/components/button/index.d.ts +13 -13
  11. package/components/button/index.js +12 -12
  12. package/components/button-icon/index.d.ts +8 -8
  13. package/components/button-icon/index.js +7 -7
  14. package/components/card/index.d.ts +8 -8
  15. package/components/card/index.js +7 -7
  16. package/components/checkbox/index.d.ts +20 -20
  17. package/components/checkbox/index.js +18 -18
  18. package/components/chip/index.d.ts +19 -19
  19. package/components/chip/index.js +16 -16
  20. package/components/circular-progress/index.d.ts +2 -2
  21. package/components/circular-progress/index.js +1 -1
  22. package/components/collapse/collapse-item.d.ts +4 -4
  23. package/components/collapse/collapse-item.js +2 -2
  24. package/components/collapse/collapse.d.ts +6 -9
  25. package/components/collapse/collapse.js +4 -4
  26. package/components/dialog/index.d.ts +13 -13
  27. package/components/dialog/index.js +13 -13
  28. package/components/divider/index.d.ts +3 -3
  29. package/components/divider/index.js +3 -3
  30. package/components/dropdown/index.d.ts +35 -35
  31. package/components/dropdown/index.js +33 -33
  32. package/components/fab/index.d.ts +6 -6
  33. package/components/fab/index.js +6 -6
  34. package/components/layout/layout-item.d.ts +7 -7
  35. package/components/layout/layout-item.js +6 -6
  36. package/components/layout/layout-main.d.ts +2 -2
  37. package/components/layout/layout-main.js +2 -2
  38. package/components/layout/layout.d.ts +2 -2
  39. package/components/layout/layout.js +2 -2
  40. package/components/linear-progress/index.d.ts +4 -4
  41. package/components/linear-progress/index.js +3 -3
  42. package/components/list/list-item.d.ts +17 -17
  43. package/components/list/list-item.js +7 -7
  44. package/components/list/list-subheader.d.ts +2 -2
  45. package/components/list/list-subheader.js +2 -2
  46. package/components/list/list.d.ts +1 -1
  47. package/components/list/list.js +1 -1
  48. package/components/menu/menu-item.d.ts +4 -4
  49. package/components/menu/menu-item.js +2 -2
  50. package/components/menu/menu.d.ts +15 -18
  51. package/components/menu/menu.js +8 -8
  52. package/components/navigation-bar/navigation-bar-item.d.ts +5 -5
  53. package/components/navigation-bar/navigation-bar-item.js +4 -4
  54. package/components/navigation-bar/navigation-bar.d.ts +9 -8
  55. package/components/navigation-bar/navigation-bar.js +6 -6
  56. package/components/navigation-drawer/index.d.ts +19 -20
  57. package/components/navigation-drawer/index.js +44 -30
  58. package/components/navigation-rail/navigation-rail-item.d.ts +6 -6
  59. package/components/navigation-rail/navigation-rail-item.js +4 -4
  60. package/components/navigation-rail/navigation-rail.d.ts +10 -11
  61. package/components/navigation-rail/navigation-rail.js +9 -10
  62. package/components/radio/radio-group.d.ts +13 -13
  63. package/components/radio/radio-group.js +11 -11
  64. package/components/radio/radio.d.ts +3 -3
  65. package/components/radio/radio.js +3 -3
  66. package/components/range-slider/index.d.ts +4 -5
  67. package/components/range-slider/index.js +4 -5
  68. package/components/segmented-button/segmented-button-group.d.ts +17 -20
  69. package/components/segmented-button/segmented-button-group.js +11 -14
  70. package/components/segmented-button/segmented-button.d.ts +3 -3
  71. package/components/segmented-button/segmented-button.js +3 -3
  72. package/components/select/index.d.ts +31 -32
  73. package/components/select/index.js +19 -20
  74. package/components/slider/index.d.ts +1 -1
  75. package/components/slider/index.js +1 -1
  76. package/components/slider/slider-base.d.ts +15 -15
  77. package/components/slider/slider-base.js +13 -13
  78. package/components/snackbar/index.d.ts +21 -21
  79. package/components/snackbar/index.js +15 -15
  80. package/components/switch/index.d.ts +14 -14
  81. package/components/switch/index.js +11 -11
  82. package/components/tabs/tab-panel.d.ts +3 -3
  83. package/components/tabs/tab-panel.js +2 -2
  84. package/components/tabs/tab.d.ts +6 -6
  85. package/components/tabs/tab.js +5 -5
  86. package/components/tabs/tabs.d.ts +19 -19
  87. package/components/tabs/tabs.js +17 -17
  88. package/components/text-field/index.d.ts +51 -51
  89. package/components/text-field/index.js +25 -25
  90. package/components/tooltip/index.d.ts +31 -31
  91. package/components/tooltip/index.js +28 -28
  92. package/components/top-app-bar/top-app-bar-title.d.ts +4 -4
  93. package/components/top-app-bar/top-app-bar-title.js +4 -4
  94. package/components/top-app-bar/top-app-bar.d.ts +5 -5
  95. package/components/top-app-bar/top-app-bar.js +4 -4
  96. package/css-data.en.json +2826 -0
  97. package/css-data.zh-cn.json +374 -367
  98. package/custom-elements.json +1072 -1115
  99. package/html-data.en.json +6551 -0
  100. package/html-data.zh-cn.json +1420 -1435
  101. package/jsx.en.d.ts +3303 -0
  102. package/jsx.zh-cn.d.ts +3351 -0
  103. package/mdui.esm.js +9 -9
  104. package/mdui.global.js +5 -5
  105. package/package.json +6 -5
  106. package/web-types.en.json +11718 -0
  107. package/web-types.zh-cn.json +3222 -3232
@@ -4,7 +4,7 @@ import type { Ripple } from '../ripple/index.js';
4
4
  import type { CSSResultGroup, TemplateResult } from 'lit';
5
5
  declare const ListItem_base: import("@open-wc/dedupe-mixin").Constructor<import("@mdui/shared/mixins/anchor.js").AnchorMixinInterface> & import("@open-wc/dedupe-mixin").Constructor<import("../ripple/ripple-mixin.js").RippleMixinInterface> & import("@open-wc/dedupe-mixin").Constructor<import("@mdui/shared/mixins/focusable.js").FocusableMixinInterface> & typeof MduiElement;
6
6
  /**
7
- * @summary 列表项组件。需与 `<mdui-list>` 组件配合使用
7
+ * @summary 列表项组件。需配合 `<mdui-list>` 组件使用
8
8
  *
9
9
  * ```html
10
10
  * <mdui-list>
@@ -30,8 +30,8 @@ declare const ListItem_base: import("@open-wc/dedupe-mixin").Constructor<import(
30
30
  * @csspart headline - 主标题
31
31
  * @csspart description - 副标题
32
32
  *
33
- * @cssprop --shape-corner - 列表项的圆角大小。可以指定一个具体的像素值;但更推荐[引用设计令牌](/docs/2/styles/design-tokens#shape-corner)
34
- * @cssprop --shape-corner-rounded - 指定了 `rounded` 时,列表项的圆角大小。可以指定一个具体的像素值;但更推荐[引用设计令牌](/docs/2/styles/design-tokens#shape-corner)
33
+ * @cssprop --shape-corner - 列表项的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
34
+ * @cssprop --shape-corner-rounded - 指定了 `rounded` 属性时,列表项的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
35
35
  */
36
36
  export declare class ListItem extends ListItem_base<ListItemEventMap> {
37
37
  static styles: CSSResultGroup;
@@ -40,25 +40,25 @@ export declare class ListItem extends ListItem_base<ListItemEventMap> {
40
40
  */
41
41
  headline?: string;
42
42
  /**
43
- * 主文本行数,超过行数限制后会截断显示。默认为没有行数限制。可选值为:
43
+ * 主文本行数,超过限制后将截断显示。默认无行数限制。可选值包括:
44
44
  *
45
- * * `1`:显示单行文本,超出后截断显示
46
- * * `2`:显示两行文本,超出后截断显示
47
- * * `3`:显示三行文本,超出后截断显示
45
+ * * `1`:显示单行,超出后截断
46
+ * * `2`:显示两行,超出后截断
47
+ * * `3`:显示三行,超出后截断
48
48
  */
49
- headlineLine?: /*显示单行文本,超出后截断显示*/ 1 | /*显示两行文本,超出后截断显示*/ 2 | /*显示三行文本,超出后截断显示*/ 3;
49
+ headlineLine?: /*显示单行,超出后截断*/ 1 | /*显示两行,超出后截断*/ 2 | /*显示三行,超出后截断*/ 3;
50
50
  /**
51
51
  * 副文本。也可以通过 `slot="description"` 设置
52
52
  */
53
53
  description?: string;
54
54
  /**
55
- * 副文本行数,超过行数限制后会截断显示。默认为没有行数限制。可选值为:
55
+ * 副文本行数,超过限制后将截断显示。默认无行数限制。可选值包括:
56
56
  *
57
- * * `1`:显示单行文本,超出后截断显示
58
- * * `2`:显示两行文本,超出后截断显示
59
- * * `3`:显示三行文本,超出后截断显示
57
+ * * `1`:显示单行,超出后截断
58
+ * * `2`:显示两行,超出后截断
59
+ * * `3`:显示三行,超出后截断
60
60
  */
61
- descriptionLine?: 1 | 2 | 3;
61
+ descriptionLine?: /*显示单行,超出后截断*/ 1 | /*显示两行,超出后截断*/ 2 | /*显示三行,超出后截断*/ 3;
62
62
  /**
63
63
  * 左侧的 Material Icons 图标名。也可以通过 `slot="icon"` 设置
64
64
  */
@@ -68,7 +68,7 @@ export declare class ListItem extends ListItem_base<ListItemEventMap> {
68
68
  */
69
69
  endIcon?: string;
70
70
  /**
71
- * 是否禁用该列表项,列表项将置灰,且其中的 [`<mdui-checkbox>`](/docs/2/components/checkbox)、[`<mdui-radio>`](/docs/2/components/radio)、[`<mdui-switch>`](/docs/2/components/switch) 等都将禁用
71
+ * 是否禁用该列表项,禁用后,列表项将变为灰色,且其中的 [`<mdui-checkbox>`](/docs/2/components/checkbox)、[`<mdui-radio>`](/docs/2/components/radio)、[`<mdui-switch>`](/docs/2/components/switch) 等也将禁用
72
72
  */
73
73
  disabled: boolean;
74
74
  /**
@@ -76,15 +76,15 @@ export declare class ListItem extends ListItem_base<ListItemEventMap> {
76
76
  */
77
77
  active: boolean;
78
78
  /**
79
- * 是否使列表项不可点击,但其中的 [`<mdui-checkbox>`](/docs/2/components/checkbox)、[`<mdui-radio>`](/docs/2/components/radio)、[`<mdui-switch>`](/docs/2/components/switch) 等仍可进行交互
79
+ * 是否使列表项不可点击。设置后,列表项中的 [`<mdui-checkbox>`](/docs/2/components/checkbox)、[`<mdui-radio>`](/docs/2/components/radio)、[`<mdui-switch>`](/docs/2/components/switch) 等仍可交互
80
80
  */
81
81
  nonclickable: boolean;
82
82
  /**
83
- * 使用圆角形状的列表项
83
+ * 是否使用圆角形状的列表项
84
84
  */
85
85
  rounded: boolean;
86
86
  /**
87
- * 列表项的垂直对齐方式。可选值为:
87
+ * 列表项的垂直对齐方式。可选值包括:
88
88
  *
89
89
  * * `start`:顶部对齐
90
90
  * * `center`:居中对齐
@@ -15,7 +15,7 @@ import '../icon.js';
15
15
  import { RippleMixin } from '../ripple/ripple-mixin.js';
16
16
  import { listItemStyle } from './list-item-style.js';
17
17
  /**
18
- * @summary 列表项组件。需与 `<mdui-list>` 组件配合使用
18
+ * @summary 列表项组件。需配合 `<mdui-list>` 组件使用
19
19
  *
20
20
  * ```html
21
21
  * <mdui-list>
@@ -41,14 +41,14 @@ import { listItemStyle } from './list-item-style.js';
41
41
  * @csspart headline - 主标题
42
42
  * @csspart description - 副标题
43
43
  *
44
- * @cssprop --shape-corner - 列表项的圆角大小。可以指定一个具体的像素值;但更推荐[引用设计令牌](/docs/2/styles/design-tokens#shape-corner)
45
- * @cssprop --shape-corner-rounded - 指定了 `rounded` 时,列表项的圆角大小。可以指定一个具体的像素值;但更推荐[引用设计令牌](/docs/2/styles/design-tokens#shape-corner)
44
+ * @cssprop --shape-corner - 列表项的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
45
+ * @cssprop --shape-corner-rounded - 指定了 `rounded` 属性时,列表项的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
46
46
  */
47
47
  let ListItem = class ListItem extends AnchorMixin(RippleMixin(FocusableMixin(MduiElement))) {
48
48
  constructor() {
49
49
  super(...arguments);
50
50
  /**
51
- * 是否禁用该列表项,列表项将置灰,且其中的 [`<mdui-checkbox>`](/docs/2/components/checkbox)、[`<mdui-radio>`](/docs/2/components/radio)、[`<mdui-switch>`](/docs/2/components/switch) 等都将禁用
51
+ * 是否禁用该列表项,禁用后,列表项将变为灰色,且其中的 [`<mdui-checkbox>`](/docs/2/components/checkbox)、[`<mdui-radio>`](/docs/2/components/radio)、[`<mdui-switch>`](/docs/2/components/switch) 等也将禁用
52
52
  */
53
53
  this.disabled = false;
54
54
  /**
@@ -56,15 +56,15 @@ let ListItem = class ListItem extends AnchorMixin(RippleMixin(FocusableMixin(Mdu
56
56
  */
57
57
  this.active = false;
58
58
  /**
59
- * 是否使列表项不可点击,但其中的 [`<mdui-checkbox>`](/docs/2/components/checkbox)、[`<mdui-radio>`](/docs/2/components/radio)、[`<mdui-switch>`](/docs/2/components/switch) 等仍可进行交互
59
+ * 是否使列表项不可点击。设置后,列表项中的 [`<mdui-checkbox>`](/docs/2/components/checkbox)、[`<mdui-radio>`](/docs/2/components/radio)、[`<mdui-switch>`](/docs/2/components/switch) 等仍可交互
60
60
  */
61
61
  this.nonclickable = false;
62
62
  /**
63
- * 使用圆角形状的列表项
63
+ * 是否使用圆角形状的列表项
64
64
  */
65
65
  this.rounded = false;
66
66
  /**
67
- * 列表项的垂直对齐方式。可选值为:
67
+ * 列表项的垂直对齐方式。可选值包括:
68
68
  *
69
69
  * * `start`:顶部对齐
70
70
  * * `center`:居中对齐
@@ -1,7 +1,7 @@
1
1
  import { MduiElement } from '@mdui/shared/base/mdui-element.js';
2
2
  import type { CSSResultGroup, TemplateResult } from 'lit';
3
3
  /**
4
- * @summary 列表标题组件。需与 `<mdui-list>` 组件配合使用
4
+ * @summary 列表标题组件。需配合 `<mdui-list>` 组件使用
5
5
  *
6
6
  * ```html
7
7
  * <mdui-list>
@@ -11,7 +11,7 @@ import type { CSSResultGroup, TemplateResult } from 'lit';
11
11
  * </mdui-list>
12
12
  * ```
13
13
  *
14
- * @slot - 文本
14
+ * @slot - 列表标题文本
15
15
  */
16
16
  export declare class ListSubheader extends MduiElement<ListSubheaderEventMap> {
17
17
  static styles: CSSResultGroup;
@@ -5,7 +5,7 @@ import { MduiElement } from '@mdui/shared/base/mdui-element.js';
5
5
  import { componentStyle } from '@mdui/shared/lit-styles/component-style.js';
6
6
  import { listSubheaderStyle } from './list-subheader-style.js';
7
7
  /**
8
- * @summary 列表标题组件。需与 `<mdui-list>` 组件配合使用
8
+ * @summary 列表标题组件。需配合 `<mdui-list>` 组件使用
9
9
  *
10
10
  * ```html
11
11
  * <mdui-list>
@@ -15,7 +15,7 @@ import { listSubheaderStyle } from './list-subheader-style.js';
15
15
  * </mdui-list>
16
16
  * ```
17
17
  *
18
- * @slot - 文本
18
+ * @slot - 列表标题文本
19
19
  */
20
20
  let ListSubheader = class ListSubheader extends MduiElement {
21
21
  render() {
@@ -1,7 +1,7 @@
1
1
  import { MduiElement } from '@mdui/shared/base/mdui-element.js';
2
2
  import type { CSSResultGroup, TemplateResult } from 'lit';
3
3
  /**
4
- * @summary 列表组件。需与 `<mdui-list-item>` 组件配合使用
4
+ * @summary 列表组件。需配合 `<mdui-list-item>` 组件使用
5
5
  *
6
6
  * ```html
7
7
  * <mdui-list>
@@ -5,7 +5,7 @@ import { MduiElement } from '@mdui/shared/base/mdui-element.js';
5
5
  import { componentStyle } from '@mdui/shared/lit-styles/component-style.js';
6
6
  import { listStyle } from './list-style.js';
7
7
  /**
8
- * @summary 列表组件。需与 `<mdui-list-item>` 组件配合使用
8
+ * @summary 列表组件。需配合 `<mdui-list-item>` 组件使用
9
9
  *
10
10
  * ```html
11
11
  * <mdui-list>
@@ -12,7 +12,7 @@ import type { Ripple } from '../ripple/index.js';
12
12
  import type { CSSResultGroup, PropertyValues, TemplateResult } from 'lit';
13
13
  declare const MenuItem_base: import("@open-wc/dedupe-mixin").Constructor<import("@mdui/shared/mixins/anchor.js").AnchorMixinInterface> & import("@open-wc/dedupe-mixin").Constructor<import("../ripple/ripple-mixin.js").RippleMixinInterface> & import("@open-wc/dedupe-mixin").Constructor<import("@mdui/shared/mixins/focusable.js").FocusableMixinInterface> & typeof MduiElement;
14
14
  /**
15
- * @summary 菜单项组件
15
+ * @summary 菜单项组件。需配合 `<mdui-menu>` 组件使用
16
16
  *
17
17
  * ```html
18
18
  * <mdui-menu>
@@ -47,17 +47,17 @@ declare const MenuItem_base: import("@open-wc/dedupe-mixin").Constructor<import(
47
47
  export declare class MenuItem extends MenuItem_base<MenuItemEventMap> {
48
48
  static styles: CSSResultGroup;
49
49
  /**
50
- * 该菜单项的值
50
+ * 菜单项的值
51
51
  */
52
52
  value?: string;
53
53
  /**
54
- * 是否禁用该菜单项
54
+ * 是否禁用菜单项
55
55
  */
56
56
  disabled: boolean;
57
57
  /**
58
58
  * 左侧的 Material Icons 图标名。也可以通过 `slot="icon"` 设置
59
59
  *
60
- * 如果需要在左侧留出一个图标的位置,可以传入空字符串进行占位
60
+ * 如果左侧不需要显示图标,但需要预留一个图标的位置,可传入空字符串进行占位
61
61
  */
62
62
  icon?: string;
63
63
  /**
@@ -30,7 +30,7 @@ import '../icon.js';
30
30
  import { RippleMixin } from '../ripple/ripple-mixin.js';
31
31
  import { menuItemStyle } from './menu-item-style.js';
32
32
  /**
33
- * @summary 菜单项组件
33
+ * @summary 菜单项组件。需配合 `<mdui-menu>` 组件使用
34
34
  *
35
35
  * ```html
36
36
  * <mdui-menu>
@@ -66,7 +66,7 @@ let MenuItem = class MenuItem extends AnchorMixin(RippleMixin(FocusableMixin(Mdu
66
66
  constructor() {
67
67
  super();
68
68
  /**
69
- * 是否禁用该菜单项
69
+ * 是否禁用菜单项
70
70
  */
71
71
  this.disabled = false;
72
72
  /**
@@ -15,7 +15,7 @@ import type { CSSResultGroup, PropertyValues, TemplateResult } from 'lit';
15
15
  * * `Enter` - 包含子菜单时,打开子菜单;为链接时,跳转链接
16
16
  * * `Escape` - 子菜单已打开时,关闭子菜单
17
17
  *
18
- * @summary 菜单组件。需与 `<mdui-menu-item>` 组件配合使用
18
+ * @summary 菜单组件。需配合 `<mdui-menu-item>` 组件使用
19
19
  *
20
20
  * ```html
21
21
  * <mdui-menu>
@@ -24,49 +24,46 @@ import type { CSSResultGroup, PropertyValues, TemplateResult } from 'lit';
24
24
  * </mdui-menu>
25
25
  * ```
26
26
  *
27
- * @event change - 菜单项的选中状态变化时触发
27
+ * @event change - 菜单项选中状态变化时触发
28
28
  *
29
29
  * @slot - 子菜单项(`<mdui-menu-item>`)、分割线([`<mdui-divider>`](/docs/2/components/divider))等元素
30
30
  *
31
- * @cssprop --shape-corner - 组件的圆角大小。可以指定一个具体的像素值;但更推荐[引用设计令牌](/docs/2/styles/design-tokens#shape-corner)
31
+ * @cssprop --shape-corner - 组件的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
32
32
  */
33
33
  export declare class Menu extends MduiElement<MenuEventMap> {
34
34
  static styles: CSSResultGroup;
35
35
  /**
36
- * 菜单项的可选中状态。默认为不可选中。可选值为:
36
+ * 菜单项的可选状态。默认不可选。可选值包括:
37
37
  *
38
- * * `single`:最多只能选中一个
39
- * * `multiple`:可以选中多个
38
+ * * `single`:单选
39
+ * * `multiple`:多选
40
40
  */
41
- selects?: /*最多只能选中一个*/ 'single' | /*可以选中多个*/ 'multiple';
41
+ selects?: /*单选*/ 'single' | /*多选*/ 'multiple';
42
42
  /**
43
- * 当前选中的 `<mdui-menu-item>` 的值
43
+ * 当前选中的 `<mdui-menu-item>` 的值。
44
44
  *
45
- * Note:
46
- * 该属性的 HTML 属性始终为字符串,且仅在 `selects="single"` 时可以通过 HTML 属性设置初始值;
47
- * 该属性的 JavaScript 属性值在 `selects="single"` 时为字符串、在 `selects="multiple"` 时为字符串数组。
48
- * 所以,在 `selects="multiple"` 时,如果要修改该值,只能通过修改 JavaScript 属性值实现。
45
+ * **Note**:该属性的 HTML 属性始终为字符串,仅在 `selects="single"` 时可通过 HTML 属性设置初始值;该属性的 JavaScript 属性值在 `selects="single"` 时为字符串,在 `selects="multiple"` 时为字符串数组。因此,在 `selects="multiple"` 时,若要修改该值,只能通过修改 JavaScript 属性值实现。
49
46
  */
50
47
  value?: string | string[];
51
48
  /**
52
- * 菜单项是否使用更紧凑的布局
49
+ * 菜单项是否使用紧凑布局
53
50
  */
54
51
  dense: boolean;
55
52
  /**
56
- * 子菜单的触发方式,支持传入多个值,用空格分隔。可选值为:
53
+ * 子菜单的触发方式,支持多个值,用空格分隔。可选值包括:
57
54
  *
58
55
  * * `click`:点击菜单项时打开子菜单
59
56
  * * `hover`:鼠标悬浮到菜单项上时打开子菜单
60
57
  * * `focus`:聚焦到菜单项上时打开子菜单
61
- * * `manual`:使用了该值时,只能使用编程方式打开和关闭子菜单,且不能再指定其他触发方式
58
+ * * `manual`:仅能通过编程方式打开和关闭子菜单,不能再指定其他触发方式
62
59
  */
63
- submenuTrigger: /*点击菜单项时打开子菜单*/ 'click' | /*鼠标悬浮到菜单项上时打开子菜单*/ 'hover' | /*聚焦到菜单项上时打开子菜单*/ 'focus' | /*使用了该值时,只能使用编程方式打开和关闭子菜单,且不能再指定其他触发方式*/ 'manual' | string;
60
+ submenuTrigger: /*点击菜单项时打开子菜单*/ 'click' | /*鼠标悬浮到菜单项上时打开子菜单*/ 'hover' | /*聚焦到菜单项上时打开子菜单*/ 'focus' | /*仅能通过编程方式打开和关闭子菜单,不能再指定其他触发方式*/ 'manual' | string;
64
61
  /**
65
- * 通过 hover 触发子菜单打开时的延时,单位为毫秒
62
+ * 鼠标悬浮触发子菜单打开的延时,单位毫秒
66
63
  */
67
64
  submenuOpenDelay: number;
68
65
  /**
69
- * 通过 hover 触发子菜单关闭时的延时,单位为毫秒
66
+ * 鼠标悬浮触发子菜单关闭的延时,单位毫秒
70
67
  */
71
68
  submenuCloseDelay: number;
72
69
  private selectedKeys;
@@ -26,7 +26,7 @@ import { menuStyle } from './menu-style.js';
26
26
  * * `Enter` - 包含子菜单时,打开子菜单;为链接时,跳转链接
27
27
  * * `Escape` - 子菜单已打开时,关闭子菜单
28
28
  *
29
- * @summary 菜单组件。需与 `<mdui-menu-item>` 组件配合使用
29
+ * @summary 菜单组件。需配合 `<mdui-menu-item>` 组件使用
30
30
  *
31
31
  * ```html
32
32
  * <mdui-menu>
@@ -35,34 +35,34 @@ import { menuStyle } from './menu-style.js';
35
35
  * </mdui-menu>
36
36
  * ```
37
37
  *
38
- * @event change - 菜单项的选中状态变化时触发
38
+ * @event change - 菜单项选中状态变化时触发
39
39
  *
40
40
  * @slot - 子菜单项(`<mdui-menu-item>`)、分割线([`<mdui-divider>`](/docs/2/components/divider))等元素
41
41
  *
42
- * @cssprop --shape-corner - 组件的圆角大小。可以指定一个具体的像素值;但更推荐[引用设计令牌](/docs/2/styles/design-tokens#shape-corner)
42
+ * @cssprop --shape-corner - 组件的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
43
43
  */
44
44
  let Menu = class Menu extends MduiElement {
45
45
  constructor() {
46
46
  super(...arguments);
47
47
  /**
48
- * 菜单项是否使用更紧凑的布局
48
+ * 菜单项是否使用紧凑布局
49
49
  */
50
50
  this.dense = false;
51
51
  /**
52
- * 子菜单的触发方式,支持传入多个值,用空格分隔。可选值为:
52
+ * 子菜单的触发方式,支持多个值,用空格分隔。可选值包括:
53
53
  *
54
54
  * * `click`:点击菜单项时打开子菜单
55
55
  * * `hover`:鼠标悬浮到菜单项上时打开子菜单
56
56
  * * `focus`:聚焦到菜单项上时打开子菜单
57
- * * `manual`:使用了该值时,只能使用编程方式打开和关闭子菜单,且不能再指定其他触发方式
57
+ * * `manual`:仅能通过编程方式打开和关闭子菜单,不能再指定其他触发方式
58
58
  */
59
59
  this.submenuTrigger = 'click hover';
60
60
  /**
61
- * 通过 hover 触发子菜单打开时的延时,单位为毫秒
61
+ * 鼠标悬浮触发子菜单打开的延时,单位毫秒
62
62
  */
63
63
  this.submenuOpenDelay = 200;
64
64
  /**
65
- * 通过 hover 触发子菜单关闭时的延时,单位为毫秒
65
+ * 鼠标悬浮触发子菜单关闭的延时,单位毫秒
66
66
  */
67
67
  this.submenuCloseDelay = 200;
68
68
  // 因为 menu-item 的 value 可能会重复,所有在每一个 menu-item 元素上都加了一个唯一的 key 属性,通过 selectedKeys 来记录选中状态的 key
@@ -4,7 +4,7 @@ import type { Ripple } from '../ripple/index.js';
4
4
  import type { CSSResultGroup, TemplateResult } from 'lit';
5
5
  declare const NavigationBarItem_base: import("@open-wc/dedupe-mixin").Constructor<import("@mdui/shared/mixins/anchor.js").AnchorMixinInterface> & import("@open-wc/dedupe-mixin").Constructor<import("../ripple/ripple-mixin.js").RippleMixinInterface> & import("@open-wc/dedupe-mixin").Constructor<import("@mdui/shared/mixins/focusable.js").FocusableMixinInterface> & typeof MduiElement;
6
6
  /**
7
- * @summary 底部导航栏项组件。需与 `<mdui-navigation-bar>` 组件配合使用
7
+ * @summary 底部导航栏项组件。需配合 `<mdui-navigation-bar>` 组件使用
8
8
  *
9
9
  * ```html
10
10
  * <mdui-navigation-bar>
@@ -14,7 +14,7 @@ declare const NavigationBarItem_base: import("@open-wc/dedupe-mixin").Constructo
14
14
  * </mdui-navigation-bar>
15
15
  * ```
16
16
  *
17
- * @slot - 文本
17
+ * @slot - 导航项文本
18
18
  * @slot icon - 图标
19
19
  * @slot active-icon - 激活状态的图标元素
20
20
  * @slot badge - 徽标
@@ -27,9 +27,9 @@ declare const NavigationBarItem_base: import("@open-wc/dedupe-mixin").Constructo
27
27
  * @csspart badge - 徽标
28
28
  * @csspart icon - 图标
29
29
  * @csspart active-icon - 激活状态的图标
30
- * @csspart label - 文本
30
+ * @csspart label - 导航项文本
31
31
  *
32
- * @cssprop --shape-corner-indicator - 指示器的圆角大小。可以指定一个具体的像素值;但更推荐[引用设计令牌](/docs/2/styles/design-tokens#shape-corner)
32
+ * @cssprop --shape-corner-indicator - 指示器的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
33
33
  */
34
34
  export declare class NavigationBarItem extends NavigationBarItem_base<NavigationBarItemEventMap> {
35
35
  static styles: CSSResultGroup;
@@ -42,7 +42,7 @@ export declare class NavigationBarItem extends NavigationBarItem_base<Navigation
42
42
  */
43
43
  activeIcon?: string;
44
44
  /**
45
- * 该导航项的值
45
+ * 导航项的值
46
46
  */
47
47
  value?: string;
48
48
  /**
@@ -15,7 +15,7 @@ import '../icon.js';
15
15
  import { RippleMixin } from '../ripple/ripple-mixin.js';
16
16
  import { navigationBarItemStyle } from './navigation-bar-item-style.js';
17
17
  /**
18
- * @summary 底部导航栏项组件。需与 `<mdui-navigation-bar>` 组件配合使用
18
+ * @summary 底部导航栏项组件。需配合 `<mdui-navigation-bar>` 组件使用
19
19
  *
20
20
  * ```html
21
21
  * <mdui-navigation-bar>
@@ -25,7 +25,7 @@ import { navigationBarItemStyle } from './navigation-bar-item-style.js';
25
25
  * </mdui-navigation-bar>
26
26
  * ```
27
27
  *
28
- * @slot - 文本
28
+ * @slot - 导航项文本
29
29
  * @slot icon - 图标
30
30
  * @slot active-icon - 激活状态的图标元素
31
31
  * @slot badge - 徽标
@@ -38,9 +38,9 @@ import { navigationBarItemStyle } from './navigation-bar-item-style.js';
38
38
  * @csspart badge - 徽标
39
39
  * @csspart icon - 图标
40
40
  * @csspart active-icon - 激活状态的图标
41
- * @csspart label - 文本
41
+ * @csspart label - 导航项文本
42
42
  *
43
- * @cssprop --shape-corner-indicator - 指示器的圆角大小。可以指定一个具体的像素值;但更推荐[引用设计令牌](/docs/2/styles/design-tokens#shape-corner)
43
+ * @cssprop --shape-corner-indicator - 指示器的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
44
44
  */
45
45
  let NavigationBarItem = class NavigationBarItem extends AnchorMixin(RippleMixin(FocusableMixin(MduiElement))) {
46
46
  constructor() {
@@ -5,7 +5,7 @@ import type { ScrollPaddingPosition } from '@mdui/shared/mixins/scrollBehavior.j
5
5
  import type { CSSResultGroup, TemplateResult } from 'lit';
6
6
  declare const NavigationBar_base: import("@open-wc/dedupe-mixin").Constructor<import("@mdui/shared/mixins/scrollBehavior.js").ScrollBehaviorMixinInterface> & typeof LayoutItemBase;
7
7
  /**
8
- * @summary 底部导航栏组件。需与 `<mdui-navigation-bar-item>` 组件配合使用
8
+ * @summary 底部导航栏组件。需配合 `<mdui-navigation-bar-item>` 组件使用
9
9
  *
10
10
  * ```html
11
11
  * <mdui-navigation-bar>
@@ -23,8 +23,8 @@ declare const NavigationBar_base: import("@open-wc/dedupe-mixin").Constructor<im
23
23
  *
24
24
  * @slot - `<mdui-navigation-bar-item>` 组件
25
25
  *
26
- * @cssprop --shape-corner - 组件的圆角大小。可以指定一个具体的像素值;但更推荐[引用设计令牌](/docs/2/styles/design-tokens#shape-corner)
27
- * @cssprop --z-index - 组件的 CSS `z-index` 值
26
+ * @cssprop --shape-corner - 组件的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
27
+ * @cssprop --z-index - 组件的 CSS `z-index` 值
28
28
  */
29
29
  export declare class NavigationBar extends NavigationBar_base<NavigationBarEventMap> {
30
30
  static styles: CSSResultGroup;
@@ -33,20 +33,21 @@ export declare class NavigationBar extends NavigationBar_base<NavigationBarEvent
33
33
  */
34
34
  hide: boolean;
35
35
  /**
36
- * 文本的可视状态。可选值为:
36
+ * 文本的可视状态。可选值包括:
37
37
  *
38
- * * `auto`:小于等于3个选项时,始终显示;大于3个选项时,仅显示选中状态的文本
39
- * * `selected`:仅选中状态显示文本
38
+ * * `auto`:当选项小于等于3个时,始终显示文本;当选项大于3个时,仅显示选中状态的文本
39
+ * * `selected`:仅在选中状态显示文本
40
40
  * * `labeled`:始终显示文本
41
41
  * * `unlabeled`:始终不显示文本
42
42
  */
43
- labelVisibility: /*小于等于3个选项时,始终显示;大于3个选项时,仅显示选中状态的文本*/ 'auto' | /*仅选中状态显示文本*/ 'selected' | /*始终显示文本*/ 'labeled' | /*始终不显示文本*/ 'unlabeled';
43
+ labelVisibility: /*当选项小于等于3个时,始终显示文本;当选项大于3个时,仅显示选中状态的文本*/ 'auto' | /*仅在选中状态显示文本*/ 'selected' | /*始终显示文本*/ 'labeled' | /*始终不显示文本*/ 'unlabeled';
44
44
  /**
45
45
  * 当前选中的 `<mdui-navigation-bar-item>` 的值
46
46
  */
47
47
  value?: string;
48
48
  /**
49
- * 滚动行为。可选值为:
49
+ * 滚动行为。可选值包括:
50
+ *
50
51
  * * `hide`:滚动时隐藏
51
52
  */
52
53
  scrollBehavior?: 'hide';
@@ -9,7 +9,7 @@ import { ScrollBehaviorMixin } from '@mdui/shared/mixins/scrollBehavior.js';
9
9
  import { LayoutItemBase } from '../layout/layout-item-base.js';
10
10
  import { navigationBarStyle } from './navigation-bar-style.js';
11
11
  /**
12
- * @summary 底部导航栏组件。需与 `<mdui-navigation-bar-item>` 组件配合使用
12
+ * @summary 底部导航栏组件。需配合 `<mdui-navigation-bar-item>` 组件使用
13
13
  *
14
14
  * ```html
15
15
  * <mdui-navigation-bar>
@@ -27,8 +27,8 @@ import { navigationBarStyle } from './navigation-bar-style.js';
27
27
  *
28
28
  * @slot - `<mdui-navigation-bar-item>` 组件
29
29
  *
30
- * @cssprop --shape-corner - 组件的圆角大小。可以指定一个具体的像素值;但更推荐[引用设计令牌](/docs/2/styles/design-tokens#shape-corner)
31
- * @cssprop --z-index - 组件的 CSS `z-index` 值
30
+ * @cssprop --shape-corner - 组件的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
31
+ * @cssprop --z-index - 组件的 CSS `z-index` 值
32
32
  */
33
33
  let NavigationBar = class NavigationBar extends ScrollBehaviorMixin(LayoutItemBase) {
34
34
  constructor() {
@@ -38,10 +38,10 @@ let NavigationBar = class NavigationBar extends ScrollBehaviorMixin(LayoutItemBa
38
38
  */
39
39
  this.hide = false;
40
40
  /**
41
- * 文本的可视状态。可选值为:
41
+ * 文本的可视状态。可选值包括:
42
42
  *
43
- * * `auto`:小于等于3个选项时,始终显示;大于3个选项时,仅显示选中状态的文本
44
- * * `selected`:仅选中状态显示文本
43
+ * * `auto`:当选项小于等于3个时,始终显示文本;当选项大于3个时,仅显示选中状态的文本
44
+ * * `selected`:仅在选中状态显示文本
45
45
  * * `labeled`:始终显示文本
46
46
  * * `unlabeled`:始终不显示文本
47
47
  */
@@ -12,52 +12,51 @@ import type { CSSResultGroup, PropertyValues, TemplateResult } from 'lit';
12
12
  * <mdui-navigation-drawer>content</mdui-navigation-drawer>
13
13
  * ```
14
14
  *
15
- * @event open - 在抽屉导航打开之前触发。可以通过调用 `event.preventDefault()` 阻止抽屉导航打开
16
- * @event opened - 在抽屉导航打开之后触发
17
- * @event close - 在抽屉导航关闭之前触发。可以通过调用 `event.preventDefault()` 阻止抽屉导航关闭
18
- * @event closed - 在抽屉导航关闭之后触发
15
+ * @event open - 抽屉栏打开之前触发。可以通过调用 `event.preventDefault()` 阻止抽屉栏打开
16
+ * @event opened - 抽屉栏打开动画完成之后触发
17
+ * @event close - 抽屉栏关闭之前触发。可以通过调用 `event.preventDefault()` 阻止抽屉栏关闭
18
+ * @event closed - 抽屉栏关闭动画完成之后触发
19
19
  * @event overlay-click - 点击遮罩层时触发
20
20
  *
21
- * @slot - 抽屉导航中的内容
21
+ * @slot - 抽屉栏中的内容
22
22
  *
23
23
  * @csspart overlay - 遮罩层
24
- * @csspart panel - 抽屉导航容器
24
+ * @csspart panel - 抽屉栏容器
25
25
  *
26
- * @cssprop --shape-corner - 组件的圆角大小。可以指定一个具体的像素值;但更推荐[引用设计令牌](/docs/2/styles/design-tokens#shape-corner)
27
- * @cssprop --z-index - 组件的 CSS `z-index` 值
26
+ * @cssprop --shape-corner - 组件的圆角大小。可以指定一个具体的像素值;但更推荐引用[设计令牌](/docs/2/styles/design-tokens#shape-corner)
27
+ * @cssprop --z-index - 组件的 CSS `z-index` 值
28
28
  */
29
29
  export declare class NavigationDrawer extends LayoutItemBase<NavigationDrawerEventMap> {
30
30
  static styles: CSSResultGroup;
31
31
  /**
32
- * 是否打开抽屉导航
32
+ * 是否打开抽屉栏
33
33
  */
34
34
  open: boolean;
35
35
  /**
36
- * 打开时,是否显示遮罩层
36
+ * 抽屉栏打开时,是否显示遮罩层
37
37
  *
38
- * 较窄的设备上(屏幕宽度小于 [`--mdui-breakpoint-md`](/docs/2/styles/design-tokens#breakpoint) 时),会无视该参数,始终显示遮罩层
38
+ * 在窄屏设备上(屏幕宽度小于 [`--mdui-breakpoint-md`](/docs/2/styles/design-tokens#breakpoint)),会始终显示遮罩层,无视该参数
39
39
  */
40
40
  modal: boolean;
41
41
  /**
42
- * 在含遮罩层时,是否在按下 ESC 键时,关闭抽屉导航
42
+ * 在有遮罩层的情况下,按下 ESC 键是否关闭抽屉栏
43
43
  */
44
44
  closeOnEsc: boolean;
45
45
  /**
46
- * 是否在点击遮罩时,关闭抽屉导航
46
+ * 点击遮罩层时,是否关闭抽屉栏
47
47
  */
48
48
  closeOnOverlayClick: boolean;
49
49
  /**
50
- * 抽屉导航的显示位置。可选值为:
50
+ * 抽屉栏的位置。可选值包括:
51
51
  *
52
- * * `left`:显示在左侧
53
- * * `right`:显示在右侧
52
+ * * `left`:左侧
53
+ * * `right`:右侧
54
54
  */
55
- placement: /*显示在左侧*/ 'left' | /*显示在右侧*/ 'right';
55
+ placement: /*左侧*/ 'left' | /*右侧*/ 'right';
56
56
  /**
57
- * 默认抽屉导航相对于 `body` 元素显示,该参数设置为 `true` 时,抽屉导航将相对于它的父元素显示
57
+ * 默认情况下,抽屉栏相对于 `body` 元素显示。当该参数设置为 `true` 时,抽屉栏将相对于其父元素显示。
58
58
  *
59
- * Note:
60
- * 设置了该属性时,必须手动在父元素上设置样式 `position: relative; overflow: hidden;`
59
+ * **Note**:设置该属性时,必须在父元素上手动设置样式 `position: relative; overflow: hidden;`。
61
60
  */
62
61
  contained: boolean;
63
62
  private mobile;