feat: init
This commit is contained in:
@@ -0,0 +1,44 @@
|
||||
---
|
||||
description: >-
|
||||
A beautiful, centered, medium modal with all you need to structure its
|
||||
content.
|
||||
---
|
||||
|
||||
# ObjectModal
|
||||
|
||||
#### Usage
|
||||
|
||||
```jsx
|
||||
import ObjectModal from "components/ObjectModal/ObjectModal.js";
|
||||
```
|
||||
|
||||
```jsx
|
||||
<ObjectModal
|
||||
title={<ObjectModalTitle>My awesome title !</ObjectModalTitle>}
|
||||
onClose={() => myComponent.closeSomething()}
|
||||
disabled
|
||||
footer={<Button>Definitly not usefull</Button>}
|
||||
>
|
||||
<FirstChild />
|
||||
<span>Some text</span>
|
||||
</ObjectModal>
|
||||
```
|
||||
|
||||
####
|
||||
|
||||
#### Props
|
||||
|
||||
| **name** | **Description** | **Type** | **Default** |
|
||||
| ------------ | -------------------------------------------------------------- | --------- | ----------- |
|
||||
| **disabled** | Disable scrollbar X axis (need to rename for a better clarity) | Boolean | false |
|
||||
| **footer** | Define a footer component | ReactNode | null |
|
||||
| **onClose** | Add close icon in the component, waiting for a function | Function | null |
|
||||
| **title** | _Define a title component_ | ReactNode | null |
|
||||
|
||||
####
|
||||
|
||||
#### Preview
|
||||
|
||||

|
||||
|
||||
---
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
---
|
||||
description: Icon with sub heading for ObjectModal component. Perfect before a form field.
|
||||
---
|
||||
|
||||
# ObjectModalFormTitle
|
||||
|
||||
#### Usage
|
||||
|
||||
```jsx
|
||||
import ObjectModalFormTitle from 'components/ObjectModal/ObjectModal.js';
|
||||
```
|
||||
|
||||
```jsx
|
||||
<ObjectModalFormTitle
|
||||
name={'Awesome Title!'}
|
||||
icon="star"
|
||||
/>
|
||||
```
|
||||
|
||||
####
|
||||
|
||||
#### Props
|
||||
|
||||
| **name** | **Description** | **Type** | **Default** |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **className** | Use predefined classes for the title | string | null |
|
||||
| **icon** | Define icon for the title | string | null |
|
||||
| **name** | Define the title name | string | null |
|
||||
| **style** | Define a custom style for the title | object | null |
|
||||
|
||||
|
||||
|
||||
+34
@@ -0,0 +1,34 @@
|
||||
---
|
||||
description: Section title, perfect after a separator.
|
||||
---
|
||||
|
||||
# ObjectModalSectionTitle
|
||||
|
||||
#### Usage
|
||||
|
||||
```jsx
|
||||
import ObjectModalFormTitle from "components/ObjectModal/ObjectModal.js";
|
||||
```
|
||||
|
||||
```jsx
|
||||
<ObjectModalFormTitle name={"Awesome Title!"} />
|
||||
```
|
||||
|
||||
####
|
||||
|
||||
#### Props
|
||||
|
||||
| **name** | **Description** | **Type** | **Default** |
|
||||
| ------------- | ------------------------------------ | -------- | ----------- |
|
||||
| **className** | Use predefined classes for the title | string | null |
|
||||
| **icon** | Define icon for the title | string | null |
|
||||
| **name** | Define the title name | string | null |
|
||||
| **style** | Define a custom style for the title | object | null |
|
||||
|
||||
####
|
||||
|
||||
#### Preview
|
||||
|
||||

|
||||
|
||||
---
|
||||
+29
@@ -0,0 +1,29 @@
|
||||
---
|
||||
description: Separate your component sections with a simple line.
|
||||
---
|
||||
|
||||
# ObjectModalSeparator
|
||||
|
||||
#### Usage
|
||||
|
||||
```jsx
|
||||
import ObjectModalSeparator from "components/ObjectModal/ObjectModal.js";
|
||||
```
|
||||
|
||||
```jsx
|
||||
<ObjectModalSeparator />
|
||||
```
|
||||
|
||||
####
|
||||
|
||||
#### Props
|
||||
|
||||
| Name | **Description** | **Type** | **Default** |
|
||||
| :--: | :----------------------------: | :------: | :---------: |
|
||||
| | no property for this component | | |
|
||||
|
||||
####
|
||||
|
||||
#### Preview
|
||||
|
||||

|
||||
+34
@@ -0,0 +1,34 @@
|
||||
---
|
||||
description: Main title for the ObjectModal component.
|
||||
---
|
||||
|
||||
# ObjectModalTitle
|
||||
|
||||
#### Usage
|
||||
|
||||
```jsx
|
||||
import ObjectModalTitle from "components/ObjectModal/ObjectModal.js";
|
||||
```
|
||||
|
||||
```jsx
|
||||
<ObjectModalTitle className="my-awesome-class" style={{ marginBottom: 0 }}>
|
||||
My awesome title !
|
||||
</ObjectModalTitle>
|
||||
```
|
||||
|
||||
####
|
||||
|
||||
#### Props
|
||||
|
||||
| **name** | **Description** | **Type** | **Default** |
|
||||
| ------------- | ------------------------------------ | -------- | ----------- |
|
||||
| **className** | Use predefined classes for the title | string | null |
|
||||
| **style** | Define a custom style for the title | object | null |
|
||||
|
||||
####
|
||||
|
||||
#### Preview
|
||||
|
||||

|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user