docs: documentation stubs for components

Author: xidedix

src/Aside.md

@@ -0,0 +1,13 @@
+### CoreUI `Aside` menu component
+
+| prop | default |
+| ------- | ---------
+| children  | 
+| className | `aside-menu`
+| display   | `sm, md, lg, xl, ""` 
+| fixed     | `false`
+| hidden    | `false`
+| isOpen    | `false`
+| offCanvas | `true`
+| tag       | `aside`
+

src/AsideToggler.md

@@ -0,0 +1,11 @@
+### CoreUI `AsideToggler` component
+
+
+prop | default
+--- | ---
+children  | `<span className="navbar-toggler-icon" />`
+className | `navbar-toggler`
+display   | `lg`
+mobile    | `false`
+tag       | `button`
+type      | `button`

src/Breadcrumb.md

@@ -0,0 +1,3 @@
+### CoreUI `Breadcrumb` component
+
+_todo_

src/Footer.md

@@ -0,0 +1,8 @@
+### CoreUI `Footer` component
+
+prop | default
+--- | ---
+children | 
+className | `app-footer`
+fixed | `false`
+tag | `footer`

src/Header.md

@@ -0,0 +1,10 @@
+### CoreUI `Header` component
+
+prop | default
+--- | ---
+children |
+className | `app-header`, `navbar`
+fixed | `false`
+tag | `header`
+
+

src/HeaderDropdown.md

@@ -0,0 +1,3 @@
+### CoreUI `HeaderDropdown` component
+
+_todo_

src/NavbarBrand.md

@@ -0,0 +1,24 @@
+### CoreUI `NavbarBrand` component
+
+
+prop | default
+--- | ---
+tag | `a`
+children | `<img src width height alt className/>`
+className | `navbar-brand`
+brand | `{src, width, height, alt, className: 'navbar-brand' }`
+full | `{src, width, height, alt, className: 'navbar-brand-full' }`
+minimized | `{src, width, height, alt, className: 'navbar-brand-minimized' }`
+
+
+example:
+```js
+import { AppNavbarBrand } from '@coreui/react';
+import logo from './logo.svg'
+import sygnet from './sygnet.svg'
+
+const full= { src: logo, width: 89, height: 25, alt: 'CoreUI Logo' }
+const minimized= { src: sygnet, width: 30, height: 30, alt: 'CoreUI Logo' }
+
+<AppNavbarBrand full={full} minimized={minimized} />
+```

src/README.md

@@ -0,0 +1,26 @@
+### [CoreUI for React](https://coreui.io/react) base components
+
+##### Layout components
+
+- [Aside](./Aside.md)
+- [AsideToggler](./AsideToggler.md)
+- [Breadcrumb](./Breadcrumb.md)
+- [Footer](./Footer.md)
+- [Header](./Header.md)
+- [HeaderDropdown](./HeaderDropdown.md)
+- [NavbarBrand](./NavbarBrand.md)
+- [Sidebar](./Sidebar.md)
+- [SidebarFooter](./SidebarFooter.md)
+- [SidebarForm](./SidebarForm.md)
+- [SidebarHeader](./SidebarHeader.md)
+- [SidebarMinimizer](./SidebarMinimizer.md)
+- [SidebarNav](./SidebarNav.md)
+- [SidebarToggler](./SidebarToggler.md)
+- [Switch](./Switch.md)
+
+
+##### Installation:
+`npm install @coreui/react`
+
+##### Import
+`import { AppAside } from '@coreui/react'`

src/Sidebar.md

@@ -0,0 +1,25 @@
+### CoreUI `Sidebar` component
+
+
+prop | default
+--- | ---
+children |
+className | `sidebar`
+compact | `false`
+display | `sm, md, lg, xl, ""` 
+fixed | `false`
+minimized | `false`
+isOpen | `false`
+offCanvas | `false`
+tag | `div`
+
+
+#### Supported content
+Sidebar come with built-in support for a handful of sub-components.
+
+- SidebarFooter
+- SidebarForm
+- SidebarHeader
+- [SidebarMinimizer](./SidebarMinimizer.md)
+- [SidebarNav](./SidebarNav.md)
+

src/SidebarFooter.md

@@ -0,0 +1,3 @@
+### CoreUI `SidebarFooter` component
+
+_todo_