GitBook: [main] 44 pages modified

Author: jonasjabari

docs/README.md

@@ -1,9 +1,5 @@
 # Install
 
-{% hint style="danger" %}
-Docs and specs in progress, please wait for official release announcement before using this gem
-{% endhint %}
-
 ### Webpacker Installation
 
 ```text

docs/SUMMARY.md

@@ -45,3 +45,4 @@
   * [Templates](api/templates/README.md)
     * [Apps](api/templates/apps/README.md)
       * [Admin App Template](api/templates/apps/admin.md)
+

docs/api/components/README.md

@@ -1,2 +1,2 @@
-# components
+# Components
 

docs/api/components/accordion.md

@@ -1,4 +1,4 @@
-# Matestack Bootstrap Component: Accordion
+# Accordion
 
 The Bootstrap `accordion` component, implemented in Ruby. Use it like any other matestack component in your apps, pages and components. It offers customizable options to simply achieve what is possible in bootstrap with this component. See below for more information about the possible options.
 
@@ -56,3 +56,4 @@ bs_accordion open: true, items: [
   }
 ]
 ```
+

docs/api/components/alert.md

@@ -1,4 +1,4 @@
-# Matestack Bootstrap Component: Alert
+# Alert
 
 The Bootstrap `alert` component, implemented in Ruby. Use it like any other matestack component in your apps, pages and components. It offers customizable options to simply achieve what is possible in bootstrap with this component. See below for more information about the possible options.
 
@@ -77,3 +77,4 @@ onclick emit: "my-event" do
   bs_btn text: "Show Alert"
 end
 ```
+

docs/api/components/badge.md

@@ -1,4 +1,4 @@
-# Matestack Bootstrap Component: Badge
+# Badge
 
 The Bootstrap `badge` component, implemented in Ruby. Use it like any other matestack component in your apps, pages and components. It offers customizable options to simply achieve what is possible in bootstrap with this component. See below for more information about the possible options.
 
@@ -60,3 +60,4 @@ Result:
 ```markup
 <span class="badge rounded-pill bg-success">Success</span>
 ```
+

docs/api/components/breadcrumb.md

@@ -1,4 +1,4 @@
-# Matestack Bootstrap Component: Breadcrumb
+# Breadcrumb
 
 The Bootstrap `breadcrumb` component, implemented in Ruby. Use it like any other matestack component in your apps, pages and components. It offers customizable options to simply achieve what is possible in bootstrap with this component. See below for more information about the possible options.
 
@@ -68,3 +68,4 @@ Result:
   </ol>
 </nav>
 ```
+

docs/api/components/button.md

@@ -1,4 +1,4 @@
-# Matestack Bootstrap Component: Button
+# Button
 
 The Bootstrap `button` component, implemented in Ruby. Use it like any other matestack component in your apps, pages and components. It offers customizable options to simply achieve what is possible in bootstrap with this component. See below for more information about the possible options.
 
@@ -13,10 +13,10 @@ Returns a bootstrap button containing text or content specified by a block. Also
 * `:size` - Use `:block, :sm, :md or :lg` to change the size of the button. The default is `nil`.
 * `:type` - Specify the type button tags. By default is set as `button`. You can set is for example as `submit`, `reset`, etc.
 * `:text` - Expects a string with the text that should go inside the button
-* `:link` - Expects a hash with parameters for a link component, button will act as a link (`a` tag with btn css classes)
-* `:transition` - Expects a hash with parameters for a transition component, button will act as a transition (`a` tag with btn css classes)
-* `:action` - Expects a hash with parameters for a action component, button will act as a action (`a` tag with btn css classes)
-* `:onclick` - Expects a hash with parameters for a onclick component, button will act as a onclick (`a` tag with btn css classes)
+* `:link` - Expects a hash with parameters for a link component, button will act as a link \(`a` tag with btn css classes\)
+* `:transition` - Expects a hash with parameters for a transition component, button will act as a transition \(`a` tag with btn css classes\)
+* `:action` - Expects a hash with parameters for a action component, button will act as a action \(`a` tag with btn css classes\)
+* `:onclick` - Expects a hash with parameters for a onclick component, button will act as a onclick \(`a` tag with btn css classes\)
 * Html attributes - all w3c confirm html attributes for div's can be set via options and will be added to the surrounding button div.
 
 ## Examples
@@ -105,3 +105,4 @@ returns
 
 <btn type="button" class="btn btn-secondary btn-lg">Large btn</btn>
 ```
+

docs/api/components/button_group.md

@@ -1,4 +1,4 @@
-# Matestack Bootstrap Component: ButtonGroup
+# ButtonGroup
 
 The Bootstrap `button group` component, implemented in Ruby. Use it like any other matestack component in your apps, pages and components. It offers customizable options to simply achieve what is possible in bootstrap with this component. See below for more information about the possible options.
 

docs/api/components/card.md

@@ -1,4 +1,4 @@
-# Matestack Bootstrap Component: Card
+# Card
 
 The Bootstrap `card` component, implemented in Ruby. Use it like any other matestack component in your apps, pages and components. It offers customizable options to simply achieve what is possible in bootstrap with this component. See below for more information about the possible options.