DocSpace-client/packages/shared/components/submenu/submenu.mdx

91 lines
3.1 KiB
Plaintext

// (c) Copyright Ascensio System SIA 2009-2024
//
// This program is a free software product.
// You can redistribute it and/or modify it under the terms
// of the GNU Affero General Public License (AGPL) version 3 as published by the Free Software
// Foundation. In accordance with Section 7(a) of the GNU AGPL its Section 15 shall be amended
// to the effect that Ascensio System SIA expressly excludes the warranty of non-infringement of
// any third-party rights.
//
// This program is distributed WITHOUT ANY WARRANTY, without even the implied warranty
// of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. For details, see
// the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
//
// You can contact Ascensio System SIA at Lubanas st. 125a-25, Riga, Latvia, EU, LV-1021.
//
// The interactive user interfaces in modified source and object code versions of the Program must
// display Appropriate Legal Notices, as required under Section 5 of the GNU AGPL version 3.
//
// Pursuant to Section 7(b) of the License you must retain the original Product logo when
// distributing the program. Pursuant to Section 7(e) we decline to grant you any rights under
// trademark law for use of our trademarks.
//
// All the Product's GUI elements, including illustrations and icon sets, as well as technical writing
// content are licensed under the terms of the Creative Commons Attribution-ShareAlike 4.0
// International. See the License terms at http://creativecommons.org/licenses/by-sa/4.0/legalcode
import { Canvas, Meta, Story } from "@storybook/blocks";
import Submenu from "./";
import * as stories from "./submenu.stories.js";
<Meta
title="Components/Submenu"
component={Submenu}
argTypes={{
data: { required: true },
}}
/>
# Submenu
<Canvas>
<Story story={stories.Default} name="Default" />
</Canvas>
### Usage
```js
import {Submenu } from "@docspace/shared/components";
```
```jsx
<Submenu
data={[
{
id: "FileInput",
name: "File Input",
content: (
<FileInput
accept={[".doc, .docx"]}
id="file-input-id"
name="demoFileInputName"
onInput={function noRefCheck() {}}
placeholder="Input file"
/>
),
},
{
id: "ToggleButton",
name: "Toggle Button",
content: (
<ToggleButton
className="toggle className"
id="toggle id"
label="label text"
onChange={() => {}}
/>
),
},
]}
startSelect={1}
/>
```
### Properties
| Props | Type | Required | Values | Default | Description |
| ------------- | :-------------: | :------: | :----: | :-----: | ----------------------------------------------------------------------------------- |
| `data` | `array` | ✅ | - | - | List of elements |
| `startSelect` | `obj`, `number` | - | - | 0 | Object from **`data`** **OR** Its index in **`data`** that will be a default select |