# @icedesign/styled-menu

> ICE 导航组件体验版

Latest version **1.0.6** (published 2019-05-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install @icedesign/styled-menu
pnpm add @icedesign/styled-menu
yarn add @icedesign/styled-menu
bun add @icedesign/styled-menu
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2019-05-22 |
| First published | 2018-02-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 231 |
| Maintainers | bindoon, chenbin93, chenjun1011, clarkxia, empireo, fenglai, jasonintju, lip966, noyobo, sobear, tao1991123, temper357, yuanyan, yujiangshui, yundong, zeroling |
| Keywords | ice-components |

## Links

- npm: https://www.npmjs.com/package/@icedesign/styled-menu
- Repository: https://github.com/ice-lab/react-materials/tree/master/components/styled-menu
- Homepage: https://unpkg.com/@icedesign/styled-menu@1.0.6/build/index.html
- npm.io page: https://npm.io/package/@icedesign/styled-menu

## Dependencies (5)

- [rc-menu](https://npm.io/package/rc-menu.md) ^5.0.9
- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [prop-types](https://npm.io/package/prop-types.md) ^15.5.10
- [@alifd/next](https://npm.io/package/@alifd/next.md) ^1.11.7
- [@icedesign/foundation-symbol](https://npm.io/package/@icedesign/foundation-symbol.md) ^1.0.0

## Recent versions

- 1.0.6 (latest) — 2019-05-22
- 0.1.4 (history) — 2019-05-25
- 1.0.2 (next) — 2019-01-15
- 0.1.3 — 2019-05-22
- 1.0.5 — 2019-03-04
- 1.0.4 — 2019-03-04
- 1.0.3 — 2019-03-04
- 1.0.1 — 2019-01-15
- 1.0.0 — 2019-01-09
- 0.1.2 — 2019-01-07
- 0.1.1 — 2018-02-24
- 0.1.0 — 2018-02-07

## README

---
title: StyledMenu
category: Components
chinese: ICE 风格导航
---

ICE 导航组件，为页面和功能提供导航的菜单列表。底层基于 rc-menu 并做了 ICE Design 的样式改造。

## 何时使用

导航菜单是一个网站的灵魂，用户依赖导航在各个页面中进行跳转。一般分为顶部导航和侧边导航，顶部导航提供全局性的类目和功能，侧边导航提供多级结构来收纳和排列网站架构。

````html
<StyledMenu>
  <StyledMenu.Item>菜单项</StyledMenu.Item>
  <StyledMenu.SubMenu title="子菜单">
    <StyledMenu.Item>子菜单项</StyledMenu.Item>
  </StyledMenu.SubMenu>
</StyledMenu>
````

## API

### Menu props

| 参数                | 说明                                                                                     | 类型                                      | 默认值     |
| ------------------- | ---------------------------------------------------------------------------------------- | ----------------------------------------- | ---------- |
| theme               | 主题颜色                                                                                 | string: `light` `dark`                    | `light`    |
| color               | 支持 Colorful ICE 配色                                                                   | string: `blue, green, orange, red, roseo` |            |
| mode                | 菜单类型，现在支持垂直、水平、和内嵌模式三种                                             | string: `vertical` `horizontal` `inline`  | `vertical` |
| selectedKeys        | 当前选中的菜单项 key 数组                                                                | string[]                                  |            |
| defaultSelectedKeys | 初始选中的菜单项 key 数组                                                                | string[]                                  |            |
| openKeys            | 当前展开的 SubMenu 菜单项 key 数组                                                       | string[]                                  |            |
| defaultOpenKeys     | 初始展开的 SubMenu 菜单项 key 数组                                                       |                                           |            |
| onOpenChange        | SubMenu 展开/关闭的回调                                                                  | Function(openKeys: string[])              | noop       |
| onSelect            | 被选中时调                                                                               | Function({ item, key, selectedKeys })     | 无         |
| onDeselect          | 取消选中时调用，仅在 multiple 生效                                                       | Function({ item, key, selectedKeys })     | -          |
| onClick             | 点击 menuitem 调用此函数，参数为 {item, key, keyPath}，在 MenuItem 上面设置 onClick 无效 | function                                  | -          |
| style               | 根节点样式                                                                               | object                                    |            |
| inlineIndent        | inline 模式的菜单缩进宽度                                                                | number                                    | 24         |
| multiple            | 是否允许多选                                                                             | boolean                                   | false      |

> More options in [rc-menu](https://github.com/react-component/menu#api)

### StyledMenu.Item props

| 参数     | 说明            | 类型    | 默认值 |
| -------- | --------------- | ------- | ------ |
| disabled | 是否禁用        | boolean | false  |
| key      | item 的唯一标志 | string  |        |

### StyledMenu.SubMenu props

| 参数         | 说明           | 类型                             | 默认值 |
| ------------ | -------------- | -------------------------------- | ------ |
| disabled     | 是否禁用       | boolean                          | false  |
| key          | 唯一标志       | string                           |        |
| title        | 子菜单项值     | string\|ReactNode                |        |
| children     | 子菜单的菜单项 | Array<MenuItem\|SubMenu>         |        |
| onTitleClick | 点击子菜单标题 | Function({ eventKey, domEvent }) |        |

### StyledMenu.ItemGroup props

| 参数     | 说明         | 类型              | 默认值 |
| -------- | ------------ | ----------------- | ------ |
| title    | 分组标题     | string\|ReactNode |        |
| children | 分组的菜单项 | MenuItem[]        |        |

### StyledMenu.Divider

菜单项分割线，只用在弹出菜单内。

---
_Source: https://npm.io/package/@icedesign/styled-menu · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._