# @aligov/bops-site-select

> 站点选择

Latest version **2.0.2** (published 2020-12-11) · 0 weekly downloads

## Install

```sh
npm install @aligov/bops-site-select
pnpm add @aligov/bops-site-select
yarn add @aligov/bops-site-select
bun add @aligov/bops-site-select
```

## 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 | 2.0.2 |
| Published | 2020-12-11 |
| First published | 2019-10-31 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | jasoncapricorn, leezq, baizhao, zhaojian6516, daip, ccs0118, zhangcong52, zwhu, guoliang.hgl, mo.zhou, zhousufa, jerrywang12, xiazhiqiang, liunian, itrip, tao1991123 |
| Keywords | ice, react, component |

## Links

- npm: https://www.npmjs.com/package/@aligov/bops-site-select
- Homepage: https://unpkg.com/@aligov/bops-site-select@2.0.2/build/index.html
- npm.io page: https://npm.io/package/@aligov/bops-site-select

## Dependencies (5)

- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [prop-types](https://npm.io/package/prop-types.md) ^15.5.8
- [@alifd/next](https://npm.io/package/@alifd/next.md) ^1.18.10
- [@aligov/util](https://npm.io/package/@aligov/util.md) ^1.1.3

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.2 (latest) — 2020-12-11
- 2.0.1 — 2019-11-29
- 2.0.0 — 2019-11-25
- 1.0.0 — 2019-10-31

## README

# 站点选择

@aligov/bops-site-select

站点选择

返回所有选择的子节点的 value。

如果一个节点下的所有子节点都已选择，那么展示父节点，返回的 value 依然是所有选择的子节点的 value。

## 基础功能

```jsx
import SiteSelect from '@aligov/bops-site-select';

<SiteSelect />
```

基于基础的功能又做了下面的定制。

## 单选

```jsx
import { SingleSiteSelect } from '@aligov/bops-site-select';

<SingleSiteSelect />
```

## 服务范围

```jsx
import { ServiceRange } from '@aligov/bops-site-select';

<ServiceRange />
```

## 当前站点

```jsx
import { CurSiteSelect } from '@aligov/bops-site-select';

<CurSiteSelect />
```

## 其他相关导出

- SiteContextProvider：站点 context provider
- SiteContextConsumer： 站点 context consumer
- useSiteContext：获取站点 context 的 hook
- CurSiteSelectProvider: 当前站点 context provider，提供了 `{ site, changeSite }` 的 value
- CurSiteSelectWithCtx：内置了 CurSiteSelectProvider，不需要手动引入
- CurSiteBox：包含了当前站点切换功能的组件，通过 children 来放置其他内容，适用于展台运营等场景
- useCurSite：一般搭配 CurSiteBox 来使用，用于在 children 中获取当前站点信息

## API

| 参数名          | 说明                                         | 必填 | 类型                       | 默认值                    | 备注                    |
| ------          | ----                                         | ---- | ----                       | ------                    | ----                    |
| rootId          | 根结点 id                                    |      | string                     |                           |                         |
| value           | 选择的值                                     |      | array                      |                           | 添加该属性表示受控      |
| queryService    | 数据加载服务                                 |      | `(rootId) => Promise<K[]>` | bops 默认服务             | 用来查询树数据          |
| onChange        | 选择变更后触发的函数                         |      | (value) => void            |                           | 一般搭配 value 来做受控 |
| multiple        | 是否多选                                     |      | boolean                    | true                      |                         |
| returnLeafValue | 多选时是否返回叶子结点的值而非使用父节点替代 |      | boolean                    | true                      |                         |
| className       | 扩展 treeSelect 的 className                 |      | string                     | mod-bops-site-select      |                         |
| popupClassName  | 扩展 treeSelect 下拉的 className             |      | string                     | mod-bops-site-select-poup |                         |


`queryService` 需要返回一个数组，数组元素类型是 `K`，其至少需要包括 `key`, `value`，`label` 和 `parentId` （父结点的 vlaue，无则为 null）属性。

基于 [TreeSelect][TreeSelect] 组件，具体参考该组件的文档。


[TreeSelect]: https://fusion.design/component/basic/tree-select

---
_Source: https://npm.io/package/@aligov/bops-site-select · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._