docs(CModal): update API documentation

mrholek · mrholek · commit 1999e43afd48 · 2022-01-22T16:33:23.000+01:00
diff --git a/packages/coreui-vue/src/components/modal/CModal.ts b/packages/coreui-vue/src/components/modal/CModal.ts
@@ -100,7 +100,7 @@ const CModal = defineComponent({
       default: true,
       required: false,
     },
-    /*
+    /**
      * By default the component is unmounted after close animation, if you want to keep the component mounted set this property to false.
      */
     unmountOnClose: {
diff --git a/packages/docs/api/modal/CModal.api.md b/packages/docs/api/modal/CModal.api.md
@@ -8,17 +8,18 @@ import CModal from '@coreui/vue/src/components/modal/CModal'
 
 #### Props
 
-| Prop name              | Description                                                                      | Type            | Values                                             | Default |
-| ---------------------- | -------------------------------------------------------------------------------- | --------------- | -------------------------------------------------- | ------- |
-| **alignment**          | Align the modal in the center or top of the screen.                              | string          | `'top'`, `'center'`                                | 'top'   |
-| **backdrop**           | Apply a backdrop on body while offcanvas is open.                                | boolean\|string | `'static'`                                         | true    |
-| **content-class-name** | A string of all className you want applied to the modal content component.       | string          | -                                                  | -       |
-| **fullscreen**         | Set modal to covers the entire user viewport                                     | boolean\|string | `boolean`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'xxl'` | -       |
-| **keyboard**           | Closes the modal when escape key is pressed.                                     | boolean         | -                                                  | true    |
-| **scrollable**         | Create a scrollable modal that allows scrolling the modal body.                  | boolean         | -                                                  |         |
-| **size**               | Size the component small, large, or extra large.                                 | string          | `'sm'`, `'lg'`, `'xl'`                             | -       |
-| **transition**         | Remove animation to create modal that simply appear rather than fade in to view. | boolean         | -                                                  | true    |
-| **visible**            | Toggle the visibility of alert component.                                        | boolean         | -                                                  |         |
+| Prop name              | Description                                                                                                                        | Type            | Values                                             | Default |
+| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------------------------------------------------- | ------- |
+| **alignment**          | Align the modal in the center or top of the screen.                                                                                | string          | `'top'`, `'center'`                                | 'top'   |
+| **backdrop**           | Apply a backdrop on body while offcanvas is open.                                                                                  | boolean\|string | `'static'`                                         | true    |
+| **content-class-name** | A string of all className you want applied to the modal content component.                                                         | string          | -                                                  | -       |
+| **fullscreen**         | Set modal to covers the entire user viewport                                                                                       | boolean\|string | `boolean`, `'sm'`, `'md'`, `'lg'`, `'xl'`, `'xxl'` | -       |
+| **keyboard**           | Closes the modal when escape key is pressed.                                                                                       | boolean         | -                                                  | true    |
+| **scrollable**         | Create a scrollable modal that allows scrolling the modal body.                                                                    | boolean         | -                                                  |         |
+| **size**               | Size the component small, large, or extra large.                                                                                   | string          | `'sm'`, `'lg'`, `'xl'`                             | -       |
+| **transition**         | Remove animation to create modal that simply appear rather than fade in to view.                                                   | boolean         | -                                                  | true    |
+| **unmount-on-close**   | By default the component is unmounted after close animation, if you want to keep the component mounted set this property to false. | boolean         | -                                                  | true    |
+| **visible**            | Toggle the visibility of alert component.                                                                                          | boolean         | -                                                  |         |
 
 #### Events
 
diff --git a/packages/docs/components/modal.md b/packages/docs/components/modal.md
@@ -81,8 +81,6 @@ Toggle a working modal demo by clicking the button below. It will slide down and
   }
 </script>
 ```
-
-
 ### Static backdrop
 
 If you set `backdrop` property to `static`, your modal will behave as though the backdrop is static, meaning it will not close when clicking outside it. Click the button below to try it.

Original file line number	Diff line number	Diff line change
`@@ -81,8 +81,6 @@ Toggle a working modal demo by clicking the button below. It will slide down and`
`81`	`81`	`}`
`82`	`82`	`</script>`
`83`	`83`	```
`84`		`-`
`85`		`-`
`86`	`84`	`### Static backdrop`
`87`	`85`
`88`	`86`	If you set `backdrop` property to `static`, your modal will behave as though the backdrop is static, meaning it will not close when clicking outside it. Click the button below to try it.