DocSpace-client/packages/components/access-right-select
2023-02-01 22:57:07 +03:00
..
access-right-select.stories.js Web: Components: AccessRightSelect: Reworked component 2022-09-12 18:51:54 +03:00
access-right-select.stories.mdx Web:Components: editing path for assets for storybook 2023-01-16 13:40:35 +05:00
data.js Web:Common/Client/Components: add PUBLIC_DIR alias 2023-01-27 17:08:30 +03:00
index.js Web: Components: AccessRightSelect: Fixed property error 2023-02-01 22:57:07 +03:00
README.md Web:Components: editing path for assets for storybook 2023-01-16 15:04:26 +05:00
styled-accessright.js Web: Components: AccessRightSelect: Fixed description color 2022-12-05 17:09:58 +03:00

AccessRightSelect

Usage

import AccessRightSelect from "@docspace/components/AccessRightSelect";
<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:
  {
    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