DocSpace-buildtools/packages/components/access-right-select/README.md

# AccessRightSelect

### Usage

```js
import AccessRightSelect from "@docspace/components/AccessRightSelect";
```

```jsx
<AccessRightSelect
  options={options}
  onSelect={(option) => console.log("selected", option)}
  selectedOption={{
    key: "key1",
    title: "Room administrator",
    description: `Administration of rooms, archiving of rooms, inviting and managing users in rooms.`,
    icon: AccessCommentReactSvgUrl,
    quota: "free",
    color: "#20D21F",
  }}
/>
```

#### Options is an array of objects that contains the following fields:

- key
- title
- description
- icon
- quota
- color

##### Example:

```js
  {
    key: "key1",
    title: "Room administrator",
    description: `Administration of rooms, archiving of rooms, inviting and managing users in rooms.`,
    icon: AccessCommentReactSvgUrl,
    quota: "free",
    color: "#20D21F",
  }
```

### Properties

| Props            |      Type      | Required | Values | Default | Description                                                        |
| ---------------- | :------------: | :------: | :----: | :-----: | ------------------------------------------------------------------ |
| `options`        | `obj`, `array` |    ✅    |   -    |    -    | List of options                                                    |
| `onSelect`       | `obj`, `array` |    -     |   -    |    -    | Will be triggered whenever an AccessRightSelect is selected option |
| `selectedOption` |     `obj`      |    -     |   -    |    -    | The option that is selected by default                             |