feat: init

2023-03-23 11:03:16 +01:00
commit 10fe6f78d1
11518 changed files with 509786 additions and 0 deletions
@@ -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
+
+![Modal example with task editor](../../../assets/screenshot-2020-07-15-at-17.00.48.png)
+
+---