提交 e898aa7d 编写于 作者: C codecalm

.md cleanup

上级 f8db48d7
......@@ -6,6 +6,7 @@ A premium and open source dashboard template with a responsive and high-quality
![Tabler preview](/static/tabler-preview.png?raw=true)
## Status
<a href="https://www.npmjs.com/package/tabler"><a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/tabler/backers/badge.svg"/></a> <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/tabler/sponsors/badge.svg"/></a> <img src="https://img.shields.io/npm/dt/tabler.svg" alt="Total Downloads"></a> <a href="https://github.com/tabler/tabler/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/tabler.svg" alt="License"></a> <a href="https://github.com/tabler/tabler/releases"><img src="https://img.shields.io/npm/v/tabler.svg" alt="Latest Release"></a>
......@@ -13,6 +14,7 @@ A premium and open source dashboard template with a responsive and high-quality
[![Backers on Open Collective](https://opencollective.com/tabler/backers/badge.svg)](#backers)
[![Sponsors on Open Collective](https://opencollective.com/tabler/sponsors/badge.svg)](#sponsors)
## Features
We've created this admin panel for everyone who wants to create templates based on our pre-made components. Our mission is to deliver a user-friendly, clear and easy administration panel that can be used by both simple websites and sophisticated systems. The only requirement is basic HTML and CSS (and some [Liquid](https://github.com/Shopify/liquid/wiki)) knowledge — as a reward, you'll be able to manage and visualise different types of data in the easiest possible way!
......@@ -24,10 +26,12 @@ We've created this admin panel for everyone who wants to create templates based
* **Demo pages**: Tabler features over 20 individual pages using various components, which gives you the freedom to choose and combine. All components can vary in color and styling that you can easily modify using Sass. Sky is the limit!
* **Single Page Application versions:** [Tabler React](https://github.com/tabler/tabler-react) has React components for Tabler.
## Sponsor Tabler
<a href="https://github.com/sponsors/codecalm" target="_blank"><img src="/static/sponsor-banner-readme.png?raw=true" alt="Sponsor Tabler" /></a>
## Setup environment
To use our build system and run our documentation locally, you'll need a copy of Tabler's source files. Follow the steps below:
......@@ -45,6 +49,7 @@ To use our build system and run our documentation locally, you'll need a copy of
Once you complete the setup, you'll be able to run the various commands provided from the command line.
## Build locally
1. From the root `/tabler` directory, run `npm run start` in the command line.
......@@ -55,14 +60,17 @@ Once you complete the setup, you'll be able to run the various commands provided
Run `npm run build` for reforms a one off build application without refresh.
Open [http://localhost:3001](http://localhost:3001) to configure the Web server.
## Feature requests
https://tabler.canny.io/feature-requests
## Bugs and feature requests
Found a bug or have a feature request? [Please open a new issue](https://github.com/tabler/tabler/issues/new).
## Creators
**Paweł Kuna**
......@@ -71,11 +79,13 @@ Found a bug or have a feature request? [Please open a new issue](https://github.
- <https://github.com/codecalm>
- <https://codecalm.net>
## Contributors
This project exists thanks to all the people who contribute. [[Contribute](https://github.com/tabler/tabler/graphs/contributors)].
<a href="https://github.com/tabler/tabler/graphs/contributors"><img src="https://opencollective.com/tabler/contributors.svg?width=890&button=false"></a>
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tabler#backer)]
......@@ -98,6 +108,7 @@ Support this project by becoming a sponsor. Your logo will be displayed here wit
<a href="https://opencollective.com/tabler/sponsor/8/website" target="_blank"><img src="https://opencollective.com/tabler/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/tabler/sponsor/9/website" target="_blank"><img src="https://opencollective.com/tabler/sponsor/9/avatar.svg"></a>
## Copyright and license
Code and documentation copyright 2018 the [Tabler Authors](https://github.com/tabler/tabler/graphs/contributors) and [codecalm.net](https://codecalm.net). Code released under the [MIT License](https://github.com/tabler/tabler/blob/master/LICENSE).
......@@ -5,6 +5,7 @@ description: Bootstrap provides an easy way to create predefined alert messages.
bootstrap-link: components/alerts/
---
## Default markup
{% capture code %}
......@@ -45,6 +46,7 @@ Add the `alert-link` class to any links inside the alert box to create "matching
{% endcapture %}
{% include example.html code=code %}
## Alerts with icons
{% capture code %}
......@@ -57,6 +59,7 @@ Add the `alert-link` class to any links inside the alert box to create "matching
{% endcapture %}
{% include example.html code=code %}
## Alert with avatar
{% capture code %}
......@@ -69,6 +72,7 @@ Add the `alert-link` class to any links inside the alert box to create "matching
{% endcapture %}
{% include example.html code=code %}
## Alert with buttons
{% capture code %}
......
......@@ -5,6 +5,7 @@ description: A small, stand-alone script to automatically adjust textarea height
done: true
---
## Default markup
{% capture code %}
......
......@@ -4,6 +4,7 @@ menu: docs.avatars
description: Create and group avatars of various shapes and sizes with one component.
---
## Default markup
{% capture code %}
......@@ -13,6 +14,7 @@ description: Create and group avatars of various shapes and sizes with one compo
{% endcapture %}
{% include example.html code=code centered=true %}
## Avatar image
Set an image as the background.
......@@ -24,6 +26,7 @@ Set an image as the background.
{% endcapture %}
{% include example.html code=code centered=true %}
## Initials
You can easily use initials instead of images.
......@@ -37,6 +40,7 @@ You can easily use initials instead of images.
{% endcapture %}
{% include example.html code=code centered=true %}
## Avatar icons
You can also use icons in avatars.
......@@ -48,6 +52,7 @@ You can also use icons in avatars.
{% endcapture %}
{% include example.html code=code centered=true %}
## Avatar initials color
Customize the color of the avatars' background. You can click [here]({% docs_url colors %}) to see the list of available colors.
......@@ -61,6 +66,7 @@ Customize the color of the avatars' background. You can click [here]({% docs_url
{% endcapture %}
{% include example.html code=code centered=true %}
## Avatar size
Using Bootstrap’s typical naming structure, you can create a standard avatar, or scale it up to different sizes based on what’s needed.
......@@ -74,6 +80,7 @@ Using Bootstrap’s typical naming structure, you can create a standard avatar,
{% endcapture %}
{% include example.html code=code centered=true %}
## Avatar status
Add an online or offline status indicator to show user's availability.
......@@ -88,6 +95,7 @@ Add an online or offline status indicator to show user's availability.
{% endcapture %}
{% include example.html code=code centered=true %}
## Avatar shape
Change the shape of an avatar with the default Bootstrap image classes.
......@@ -101,6 +109,7 @@ Change the shape of an avatar with the default Bootstrap image classes.
{% endcapture %}
{% include example.html code=code centered=true %}
## Avatars list
You can easily create a list of avatars.
......@@ -110,6 +119,7 @@ You can easily create a list of avatars.
{% endcapture %}
{% include example.html code=code centered=true %}
## Stacked list
Make the list stack when it reaches a certain length.
......
......@@ -5,6 +5,7 @@ description: A small count and labeling component.
bootstrap-link: components/badge/
---
## Default markup
{% capture code %}
......@@ -14,6 +15,7 @@ bootstrap-link: components/badge/
{% endcapture %}
{% include example.html code=code centered=true %}
## Pill badges
To make a pill bagde (with rounded corners) add `.bagde-pill` class.
......@@ -61,6 +63,7 @@ If you don't want your badge to contain any text you can do it by leaving the ht
{% endcapture %}
{% include example.html code=code centered=true %}
### Badge addons
You can add badge addon by adding `.badge-addon` class.
......@@ -72,6 +75,7 @@ You can add badge addon by adding `.badge-addon` class.
{% endcapture %}
{% include example.html code=code %}
### Badge avatars
If you want to add an avatar to your badge just create `.badge-avatar` class.
......
......@@ -7,7 +7,7 @@ bootstrap-link: components/breadcrumb/
## Default markup
The dividers are automatically created in the content of the `:before` pseudo-element of li tags. You can inform the current page using the `active` modifier in a `li` tag. It will disable the navigation of inner links.
{% capture code %}
......@@ -15,6 +15,7 @@ The dividers are automatically created in the content of the `:before` pseudo-el
{% endcapture %}
{% include example.html code=code centered=true %}
## Breadcrumb variations
You can add more variations by modify `$breadcrumb-variants` variable in Tabler config.
......@@ -34,6 +35,7 @@ You can add more variations by modify `$breadcrumb-variants` variable in Tabler
{% endcapture %}
{% include example.html code=code centered=true %}
## Alternate version
{% capture code %}
......
......@@ -6,6 +6,7 @@ bootstrap-link: components/buttons/
done: true
---
## Button tag
The `.btn` classes are designed to be used with the `<button>` element. However, you can also use these classes on `<a>` or `<input>` elements (though some browsers may apply a slightly different rendering).
......@@ -33,6 +34,7 @@ Use any of the available button classes to quickly create a styled button . We p
{% endcapture %}
{% include example.html code=code wrapper="btn-list" centered=true %}
## Disabled buttons
Make buttons look inactive by adding the disabled boolean attribute to any `.btn` element. `<a>`s don’t support the disabled attribute, so you must add the `.disabled` class to make it visually appear disabled.
......@@ -46,6 +48,7 @@ Make buttons look inactive by adding the disabled boolean attribute to any `.btn
{% endcapture %}
{% include example.html code=code wrapper="btn-list" centered=true %}
## Color variations
The classic button, in different colors.
......@@ -57,6 +60,7 @@ The classic button, in different colors.
{% endcapture %}
{% include example.html code=code wrapper="btn-list" centered=true %}
## Ghost Buttons
Use `.btn-ghost-*` class for ghost buttons.
......@@ -68,6 +72,7 @@ Use `.btn-ghost-*` class for ghost buttons.
{% endcapture %}
{% include example.html code=code wrapper="btn-list" centered=true %}
## Square buttons
Add `.btn-square` to button to remove border-radius.
......@@ -81,6 +86,7 @@ Add `.btn-square` to button to remove border-radius.
{% endcapture %}
{% include example.html code=code wrapper="btn-list" centered=true %}
## Pill buttons
Add `.btn-pill` class to any button to make them more rounded.
......@@ -94,6 +100,7 @@ Add `.btn-pill` class to any button to make them more rounded.
{% endcapture %}
{% include example.html code=code wrapper="btn-list" centered=true %}
## Outline buttons
In need of a button, but not the hefty background colors they bring? Replace the default modifier classes with the `.btn-outline-*` ones to remove all background images and colors on any button.
......@@ -107,6 +114,7 @@ In need of a button, but not the hefty background colors they bring? Replace the
{% endcapture %}
{% include example.html code=code wrapper="btn-list" centered=true %}
## Button size
Add `.btn-lg` or `.btn-sm` for additional sizes.
......@@ -131,6 +139,7 @@ Create block level buttons—those that span the full width of a parent—by add
{% endcapture %}
{% include example.html code=code wrapper="btn-list" centered=true %}
## Button with icon
Basic buttons are traditional buttons with borders and background with an extra commponent like an icon. You can place it either on the left or the right which ever you want with different color opitons.
......@@ -165,6 +174,7 @@ Comment
{% endcapture %}
{% include example.html code=code wrapper="btn-list" centered=true %}
## Social buttons
A button can be formatted to link to a social website
......@@ -190,6 +200,7 @@ You can use only icons.
{% endcapture %}
{% include example.html code=code wrapper="btn-list" centered=true %}
## Icon buttons
Icon only button. Add `.btn-icon` class to remove unnecessary padding from button.
......@@ -234,6 +245,7 @@ Wrap the dropdown’s toggle (your button or link) and the dropdown menu within
{% endcapture %}
{% include example.html code=code wrapper="btn-list" centered=true %}
## Loading button
Add `.btn-loading` to use a loading state on a button. The width of the button depends on the length of the text inside.
......@@ -252,6 +264,7 @@ Add `.btn-loading` to use a loading state on a button. The width of the button d
{% endcapture %}
{% include example.html code=code centered=true %}
## List of buttons
You can now create a list of buttons with the `.btn-list` container.
......@@ -319,6 +332,7 @@ Use the `.text-center` or the `.text-right` modifiers to alter the alignment.
{% endcapture %}
{% include example.html code=code %}
## Button with avatar
{% capture code %}
......
......@@ -8,6 +8,7 @@ done: true
The `.card` element is simply a container with a shadow, a border, a radius, and some padding. Built with flexbox, they offer easy alignment and mix well with other Bootstrap components.
## Default card
To create a new card you have to use the `.card` and `.card-body` classes. You can put any content inside.
......@@ -17,6 +18,7 @@ To create a new card you have to use the `.card` and `.card-body` classes. You c
{% endcapture %}
{% include example.html code=code columns=1 %}
## Card padding
You can change the padding of a newly created card. You can do this with the `.card-sm`, `.card-md` and `.card-lg` classes.
......@@ -31,6 +33,7 @@ Cards with the `.card-sm` class are very well suited for small items such as sni
{% endcapture %}
{% include example.html code=code columns=2 %}
## Card with title
To add a title to a card you should add a class `.card-title` inside `.card-body`.
......@@ -43,6 +46,7 @@ You can also place the title inside the `.card-header` element - then the title
{% endcapture %}
{% include example.html code=code columns=1 %}
## Card with title and image
{% capture code %}
......@@ -50,6 +54,7 @@ You can also place the title inside the `.card-header` element - then the title
{% endcapture %}
{% include example.html code=code columns=1 %}
## Blog post card
The best way to make your post eye-catching is adding an image to it. To do so, just add the image with the `.card-img-top` class. We've added the `.d-flex .flex-column` classes to the `.card-body` to have the author details be on the bottom of the card.
......@@ -59,6 +64,7 @@ The best way to make your post eye-catching is adding an image to it. To do so,
{% endcapture %}
{% include example.html code=code columns=1 %}
## Row deck
If you want to create a couple of posts next to each other, add the `.row-deck` class to `.row`—then they will all have the same height.
......@@ -84,6 +90,7 @@ If you want to create a couple of posts next to each other, add the `.row-deck`
{% endcapture %}
{% include example.html code=code columns=2 %}
## Post card with aside image
You can also add the image on the left side of the card. All you need do to is: add the `.card-aside` class to the element with the `.card` class. Then add the image in the `.card-aside-column` element. No worries, tabler will automatically center it and scale to right size:
......@@ -93,6 +100,7 @@ You can also add the image on the left side of the card. All you need do to is:
{% endcapture %}
{% include example.html code=code columns=2 %}
## Color variations
{% capture code %}
......@@ -107,6 +115,7 @@ You can also add the image on the left side of the card. All you need do to is:
{% endcapture %}
{% include example.html code=code columns=2 %}
## Stacked card
{% capture code %}
......@@ -114,6 +123,7 @@ You can also add the image on the left side of the card. All you need do to is:
{% endcapture %}
{% include example.html code=code columns=1 %}
## Tabbed card
{% capture code %}
......
......@@ -5,6 +5,7 @@ description: The Carousel is a slideshow for cycling through elements.
bootstrap-link: components/carousel/
---
## Default markup
{% capture code %}
......
......@@ -3,6 +3,7 @@ title: Charts
menu: docs.charts
---
## Default markup
{% for chart in site.data.charts %}
......
......@@ -6,10 +6,12 @@ bootstrap-link: utilities/colors/
done: true
---
## Base colors
{% include example/colors-table.html %}
## Light colors
{% include example/colors-table.html light=true %}
......@@ -7,6 +7,7 @@ Countups with many options that can be found [here](https://inorganik.github.io/
To make countup add `data-countup` to any html text tag.
## Default countup
Set number to count up.
......@@ -16,6 +17,7 @@ Set number to count up.
{% endcapture %}
{% include example.html code=code %}
## Duration
Set the `duration` of the countup. (2s is set by default)
......@@ -27,6 +29,7 @@ Set the `duration` of the countup. (2s is set by default)
{% endcapture %}
{% include example.html code=code %}
## Starting value
Set the start value of countup using `startVal`.
......@@ -38,6 +41,7 @@ If you set it bigger than the `count`, countup will run reverse.
{% endcapture %}
{% include example.html code=code %}
## Decimal places
Set how many decimal places to show using `decimalPlaces`.
......@@ -50,6 +54,7 @@ Set how many decimal places to show using `decimalPlaces`.
{% endcapture %}
{% include example.html code=code %}
## Easing
Disable easing using `"useEasing": false`. (`true` by default)
......@@ -60,6 +65,7 @@ Disable easing using `"useEasing": false`. (`true` by default)
{% endcapture %}
{% include example.html code=code %}
## Use grouping
Disable grouping using `"useGrouping": false`. (`true` by default)
......@@ -70,6 +76,7 @@ Disable grouping using `"useGrouping": false`. (`true` by default)
{% endcapture %}
{% include example.html code=code %}
## Separator
Set seperator that seperates groups using `separator`. (`,` by default)
......@@ -82,6 +89,7 @@ Set seperator that seperates groups using `separator`. (`,` by default)
{% endcapture %}
{% include example.html code=code %}
## Decimal separator
Set decimal separator using `decimal`. (`.` by default)
......@@ -94,6 +102,7 @@ Set decimal separator using `decimal`. (`.` by default)
{% endcapture %}
{% include example.html code=code %}
## Prefix
Set countup prefix using `prefix`.
......@@ -105,6 +114,7 @@ Set countup prefix using `prefix`.
{% endcapture %}
{% include example.html code=code %}
## Suffix
Set countup suffix using `suffix`.
......
......@@ -3,6 +3,7 @@ title: Cursors
menu: docs.cursors
---
## Cursor utilities
- `.cursor-auto`- cursor style depends on what's inside element
......
......@@ -5,6 +5,7 @@ bootstrap-link: components/dropdowns/#dividers
done: true
---
## Default markup
{% capture code %}
......@@ -18,6 +19,7 @@ done: true
{% endcapture %}
{% include example.html code=code %}
## Text position
{% capture code %}
......@@ -39,6 +41,7 @@ done: true
{% endcapture %}
{% include example.html code=code %}
## Divider color
Customize the color of the divider. You can click [here]({% docs_url colors %}) to see the list of available colors.
......
......@@ -4,6 +4,7 @@ description: Toggle contextual overlays for displaying lists of links and more w
bootstrap-link: components/dropdowns
---
## Default dropdown
Any single `.btn` can be turned into a dropdown toggle with some markup changes. Here’s how you can do this:
......@@ -13,6 +14,7 @@ Any single `.btn` can be turned into a dropdown toggle with some markup changes.
{% endcapture %}
{% include example.html code=code centered=true %}
## Dropdown divider
Separate groups of related menu items with a divider.
......@@ -22,6 +24,7 @@ Separate groups of related menu items with a divider.
{% endcapture %}
{% include example.html code=code centered=true %}
## Active state
{% capture code %}
......@@ -29,6 +32,7 @@ Separate groups of related menu items with a divider.
{% endcapture %}
{% include example.html code=code centered=true %}
## Disabled state
{% capture code %}
......@@ -36,6 +40,7 @@ Separate groups of related menu items with a divider.
{% endcapture %}
{% include example.html code=code centered=true %}
## Dropdown header
Add a header to label sections of actions in any dropdown menu.
......@@ -45,6 +50,7 @@ Add a header to label sections of actions in any dropdown menu.
{% endcapture %}
{% include example.html code=code centered=true %}
## Dropdown with icons
{% capture code %}
......@@ -52,6 +58,7 @@ Add a header to label sections of actions in any dropdown menu.
{% endcapture %}
{% include example.html code=code centered=true %}
## Dropdown with arrow
{% capture code %}
......@@ -59,6 +66,7 @@ Add a header to label sections of actions in any dropdown menu.
{% endcapture %}
{% include example.html code=code centered=true %}
## Dropdown with badge
{% capture code %}
......@@ -66,6 +74,7 @@ Add a header to label sections of actions in any dropdown menu.
{% endcapture %}
{% include example.html code=code centered=true %}
## Dropdown with checkboxes
{% capture code %}
......@@ -78,6 +87,7 @@ Add a header to label sections of actions in any dropdown menu.
{% endcapture %}
{% include example.html code=code centered=true %}
## Dark dropdown
{% capture code %}
......@@ -85,6 +95,7 @@ Add a header to label sections of actions in any dropdown menu.
{% endcapture %}
{% include example.html code=code centered=true %}
## Dropdown with card content
{% capture code %}
......
......@@ -3,6 +3,7 @@ title: Empty states
description: Empty states/blanks are commonly used as placeholders for first time use, empty data or error screens.
---
## Default markup
{% capture code %}
......@@ -10,6 +11,7 @@ description: Empty states/blanks are commonly used as placeholders for first tim
{% endcapture %}
{% include example.html code=code %}
## Empty state with illustration
{% capture code %}
......
......@@ -5,6 +5,7 @@ plugin: flags
done: true
---
## Flag
{% capture code %}
......@@ -14,6 +15,7 @@ done: true
{% endcapture %}
{% include example.html code=code %}
## Flag sizes
Using Bootstrap’s typical naming structure, you can create a standard flag, or scale it up to different sizes based on what’s needed.
......@@ -26,6 +28,7 @@ Using Bootstrap’s typical naming structure, you can create a standard flag, or
{% endcapture %}
{% include example.html code=code %}
## Types
To set the flag of the country you want add a class `flag-(country name)`. For example to create a flag of Andorra your class should look like this: `.flag-ad`.
......
......@@ -3,6 +3,7 @@ title: Form Elements
bootstrap-link: components/forms/
---
## Classic Inputs
{% capture code %}
......@@ -11,6 +12,7 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
## Textarea and select
{% capture code %}
......@@ -21,6 +23,7 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
## Validation states
{% capture code %}
......@@ -28,6 +31,7 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
### Subtle validation states
{% capture code %}
......@@ -35,6 +39,7 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
## Input size
{% capture code %}
......@@ -42,6 +47,7 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
## Image check
{% capture code %}
......@@ -49,6 +55,7 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code max-width="25rem" %}
## Input color
{% capture code %}
......@@ -56,6 +63,7 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
## Input color picker
{% capture code %}
......@@ -63,6 +71,7 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
## Datalists
{% capture code %}
......@@ -70,6 +79,7 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
## Custom selectboxes
{% capture code %}
......@@ -77,6 +87,7 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
## Toggle switches
{% capture code %}
......@@ -85,33 +96,43 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
## Radios
{% capture code %}
{% include parts/form/input-radios.html %}
{% include parts/form/input-radios-inline.html %}
{% endcapture %}
{% include example.html code=code %}
## Checkboxes
{% capture code %}
{% include parts/form/input-checkboxes.html %}
{% include parts/form/input-checkboxes-inline.html %}
{% endcapture %}
{% include example.html code=code %}
## Range input
{% capture code %}
{% include parts/form/input-range.html %}
{% endcapture %}
{% include example.html code=code %}
## Sample form
{% capture code %}
{% include parts/form/fieldset.html %}
{% endcapture %}
{% include example.html code=code %}
## Input group
{% capture code %}
<div class="mb-2">
<label class="form-label">Input group</label>
......@@ -148,19 +169,25 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
## Input with icon
{% capture code %}
{% include parts/form/input-icon.html %}
{% endcapture %}
{% include example.html code=code %}
## Separated inputs
{% capture code %}
{% include parts/form/input-icon-separated.html %}
{% endcapture %}
{% include example.html code=code %}
## Custom Input examples
{% capture code %}
<div class="mb-2">
<label class="form-label">Username</label>
......@@ -184,7 +211,9 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
## Date component
{% capture code %}
<div class="mb-2">
<label class="form-label">Date of birth</label>
......@@ -225,7 +254,9 @@ bootstrap-link: components/forms/
{% endcapture %}
{% include example.html code=code %}
## Input with button
{% capture code %}
<div class="mb-2">
<label class="form-label">Button input</label>
......
......@@ -2,6 +2,7 @@
title: Form helpers
---
## Input help
{% capture code %}
......
......@@ -5,16 +5,19 @@ icon: flag
order: -1
---
## What is Tabler?
Tabler is a UI kit that speeds up the development process and makes it easier than ever! Built on the latest version of Bootstrap, it helps you create templates based on fully customisable and ready-to-use UI components, which can be used by both simple websites and sophisticated systems. With basic knowledge of HTML and CSS, you’ll be able to create dashboards that are fully functional and beautifully designed!
## What are the benefits?
Tabler is a perfect solution if you want to create an interface which is not only user-friendly but also fully reponsive. Thanks to the big choice of ready-made components, you can customise your design and adapt it to the needs of even the most demanding users. On top of that, Tabler is an open source solution, continuously developed and improved by the open source community.
To start using Tabler, first you need to set up the environment.
## Set up the environment
To use our build system and run our documentation locally, you'll need a copy of Tabler's source files. Follow the steps below:
......@@ -31,6 +34,7 @@ To use our build system and run our documentation locally, you'll need a copy of
Once you've completed the setup, you'll be able to run the various commands provided from the command line.
## Build Tabler locally
1. From the root `/tabler` directory, run `npm run start` in the command line.
......@@ -41,6 +45,7 @@ Once you've completed the setup, you'll be able to run the various commands prov
Run `npm run build` for rerforms a one off build application without refresh.
Open [http://localhost:3001](http://localhost:3001) to configure the Web server.
## Bugs and feature requests
Found a bug or have a feature request? [Please open a new issue](https://github.com/tabler/tabler/issues/new).
......@@ -2,6 +2,7 @@
title: Input mask
---
## Default markup
{% capture code %}
......
......@@ -5,6 +5,7 @@ plugin: payments
done: true
---
## Payment
{% capture code %}
......@@ -14,6 +15,7 @@ done: true
{% endcapture %}
{% include example.html code=code %}
## Payment sizes
Using Bootstrap’s typical naming structure, you can create a standard payment, or scale it up to different sizes based on what’s needed.
......@@ -26,6 +28,7 @@ Using Bootstrap’s typical naming structure, you can create a standard payment,
{% endcapture %}
{% include example.html code=code %}
## Types
<table class="table-vcenter">
......
......@@ -5,6 +5,7 @@ bootstrap-link: components/progress
done: true
---
## Default markup
To create a default progress bar, add a `.progress` class to a `<div>` element:
......@@ -14,6 +15,7 @@ To create a default progress bar, add a `.progress` class to a `<div>` element:
{% endcapture %}
{% include example.html code=code %}
## Progress size
Using Bootstrap’s typical naming structure, you can create a standard progress, or scale it up to different sizes based on what’s needed.
......@@ -23,6 +25,7 @@ Using Bootstrap’s typical naming structure, you can create a standard progress
{% endcapture %}
{% include example.html code=code %}
## Progress without value
Remove the showed value by adding a class called `.sr-only`.
......@@ -32,6 +35,7 @@ Remove the showed value by adding a class called `.sr-only`.
{% endcapture %}
{% include example.html code=code %}
## Indeterminate progress
To create indeterminate progress add `.progress-bar-indeterminate` to the `.progress-bar` element.
......@@ -41,6 +45,7 @@ To create indeterminate progress add `.progress-bar-indeterminate` to the `.prog
{% endcapture %}
{% include example.html code=code %}
## Native progress element
You can also use native HTML5 `<progress>` element.
......@@ -50,6 +55,7 @@ You can also use native HTML5 `<progress>` element.
{% endcapture %}
{% include example.html code=code %}
## Progress color
Customize the color of the progress bar. You can click [here]({% docs_url colors %}) to see the list of available colors.
......
......@@ -5,6 +5,7 @@ menu: docs.range-slider
All options and features can be found [**here**](https://refreshless.com/nouislider/).
## Basic range slider
{% capture code %}
......@@ -29,10 +30,12 @@ $(document).ready(function() {
});
```
## Basic options
Basic range slider options.
## js-name
By setting `js-name` you can access slider in your js code. **Remember to use it in your code after the page has loaded.**
......@@ -55,6 +58,7 @@ function slider(){
{% endcapture %}
{% include example.html code=code %}
## start
The `start` option sets the number of handles and corresponding start positions.
......@@ -71,6 +75,7 @@ The `start` option uses the slider's `'format'` option to decode the input. Numb
{% endcapture %}
{% include example.html code=code %}
## range
All values on the slider are part of a range. The range has a minimum and maximum value. **The minimum value cannot be equal to the maximum value.**
......@@ -85,6 +90,7 @@ All values on the slider are part of a range. The range has a minimum and maximu
{% endcapture %}
{% include example.html code=code %}
## step
By default, the slider slides fluently. In order to make the handles jump between intervals, you can use the step option.
......@@ -99,6 +105,7 @@ By default, the slider slides fluently. In order to make the handles jump betwee
{% endcapture %}
{% include example.html code=code %}
## connect
The connect option can be used to control the bar between the handles or the edges of the slider.
......@@ -118,6 +125,7 @@ Setting true sets the bars between the handles, but not between the handles and
{% endcapture %}
{% include example.html code=code %}
## margin
When using two handles, the minimum distance between the handles can be set using the margin option. The margin value is relative to the value set in 'range'. This option is only available on linear sliders.
......@@ -130,6 +138,7 @@ When using two handles, the minimum distance between the handles can be set usin
{% endcapture %}
{% include example.html code=code %}
## limit
The `limit` option is the oposite of the margin option, limiting the maximum distance between two handles. As with the margin option, the `limit` option can only be used on linear sliders.
......@@ -140,6 +149,7 @@ The `limit` option is the oposite of the margin option, limiting the maximum dis
{% endcapture %}
{% include example.html code=code %}
## padding
Padding limits how close to the slider edges handles can be.
......
......@@ -4,6 +4,7 @@ menu: docs.ribbons
done: true
---
## Default markup
{% capture code %}
......@@ -11,6 +12,7 @@ done: true
{% endcapture %}
{% include example.html code=code %}
## Ribbon position
You can easily change the position of a ribbon by adding a class to the element.
......@@ -27,6 +29,7 @@ You can also use multiple classes at once for example: `.ribbon.ribbon-top.ribbo
{% endcapture %}
{% include example.html code=code %}
## Ribbon color
Customize the ribbon's background color. You can click [here]({% docs_url colors %}) to see the list of available colors.
......@@ -36,6 +39,7 @@ Customize the ribbon's background color. You can click [here]({% docs_url colors
{% endcapture %}
{% include example.html code=code %}
## Ribbon text
Set your own text in a ribbon.
......@@ -45,6 +49,7 @@ Set your own text in a ribbon.
{% endcapture %}
{% include example.html code=code %}
## Ribbon style
Change the style of a ribbon.
......
......@@ -5,6 +5,7 @@ bootstrap-link: components/spinners/
done: true
---
## Default markup
{% capture code %}
......@@ -23,6 +24,7 @@ done: true
{% endcapture %}
{% include example.html code=code %}
## Size
{% capture code %}
......@@ -31,6 +33,7 @@ done: true
{% endcapture %}
{% include example.html code=code %}
## Growing spinner
{% capture code %}
......@@ -46,6 +49,7 @@ done: true
{% endcapture %}
{% include example.html code=code %}
## Buttons
{% capture code %}
......
......@@ -8,6 +8,7 @@ new: true
Steps are progress indicators of a sequence of task steps.
## Default markup
{% capture code %}
......@@ -15,6 +16,7 @@ Steps are progress indicators of a sequence of task steps.
{% endcapture %}
{% include example.html code=code %}
## Tooltips
{% capture code %}
......@@ -22,6 +24,7 @@ Steps are progress indicators of a sequence of task steps.
{% endcapture %}
{% include example.html code=code %}
## Color
{% capture code %}
......@@ -30,6 +33,7 @@ Steps are progress indicators of a sequence of task steps.
{% endcapture %}
{% include example.html code=code %}
## Steps without title
{% capture code %}
......@@ -37,6 +41,7 @@ Steps are progress indicators of a sequence of task steps.
{% endcapture %}
{% include example.html code=code %}
## Steps with numbers
{% capture code %}
......
......@@ -4,6 +4,7 @@ menu: docs.tables
bootstrap-link: content/tables/
---
## Basic Table
A basic Bootstrap table has a light padding and only horizontal dividers.
......@@ -15,6 +16,7 @@ The `.table` class adds basic styling to a table:
{% endcapture %}
{% include example.html code=code %}
## No wrap
Prevents table cell content from wrapping to another line.
......
......@@ -4,6 +4,7 @@ menu: docs.tabs
bootstrap-link: components/navs/
---
## Default markup
{% capture code %}
......@@ -11,6 +12,7 @@ bootstrap-link: components/navs/
{% endcapture %}
{% include example.html code=code columns=1 %}
## Tabs with icons
{% capture code %}
......@@ -18,6 +20,7 @@ bootstrap-link: components/navs/
{% endcapture %}
{% include example.html code=code columns=1 %}
## Tabs only with icons
{% capture code %}
......@@ -25,6 +28,7 @@ bootstrap-link: components/navs/
{% endcapture %}
{% include example.html code=code columns=1 %}
## Tabs with dropdown
{% capture code %}
......@@ -32,6 +36,7 @@ bootstrap-link: components/navs/
{% endcapture %}
{% include example.html code=code columns=1 %}
## Full-width tabs
{% capture code %}
......@@ -39,6 +44,7 @@ bootstrap-link: components/navs/
{% endcapture %}
{% include example.html code=code columns=1 %}
## Alternate style
{% capture code %}
......
......@@ -3,13 +3,17 @@ title: Timelines
menu: docs.timelines
---
## Timeline
{% capture code %}
{% include cards/timeline.html %}
{% endcapture %}
{% include example.html code=code %}
## Simple Timeline
{% capture code %}
{% include cards/timeline.html simple=true %}
{% endcapture %}
......
......@@ -5,6 +5,7 @@ description: The toast component is like an alert box that is only shown for a c
bootstrap-link: components/toasts/
---
## Default markup
{% capture code %}
......@@ -12,6 +13,7 @@ bootstrap-link: components/toasts/
{% endcapture %}
{% include example.html code=code %}
## Translucent
Toasts are slightly translucent, too, so they blend over whatever they might appear over. For browsers that support the `backdrop-filter` CSS property, we’ll also attempt to blur the elements under a toast.
......@@ -21,6 +23,7 @@ Toasts are slightly translucent, too, so they blend over whatever they might app
{% endcapture %}
{% include example.html code=code %}
## Stacking toasts
If you want to stack toasts just put them in the same container.
......
......@@ -5,6 +5,7 @@ description: The Tooltip component is small pop-up box that appears when the use
bootstrap-link: components/tooltips/
---
## Default markup
{% capture code %}
......@@ -23,6 +24,7 @@ bootstrap-link: components/tooltips/
{% endcapture %}
{% include example.html code=code %}
## Tooltip with HTML
{% capture code %}
......
......@@ -5,6 +5,7 @@ description: Documentation and examples for common text utilities to control ali
bootstrap-link: content/typography/
---
## Headings
{% capture code %}
......@@ -13,6 +14,7 @@ bootstrap-link: content/typography/
{% endcapture %}
{% include example.html code=code %}
## Paragraphs
{% capture code %}
......@@ -21,6 +23,7 @@ bootstrap-link: content/typography/
{% endcapture %}
{% include example.html code=code %}
## Semantic text elements
{% capture code %}
......@@ -44,6 +47,7 @@ Text <sup>Superscripted</sup>{% hide %} <code class="ml-2">sup</code><br/>{% end
{% endcapture %}
{% include example.html code=code %}
## Horizontal rules
{% capture code %}
......@@ -51,6 +55,7 @@ Text <sup>Superscripted</sup>{% hide %} <code class="ml-2">sup</code><br/>{% end
{% endcapture %}
{% include example.html code=code %}
## Horizontal rules with label
{% capture code %}
......@@ -116,6 +121,7 @@ Tabler has been optimized to correctly display content in any language. The Tabl
{% endcapture %}
{% include example.html code=code %}
## Text transform
Transform text in components with text capitalization classes.
......@@ -127,6 +133,7 @@ Transform text in components with text capitalization classes.
{% endcapture %}
{% include example.html code=code %}
## Letter spacing
Utilities for controlling the tracking (letter spacing) of an element.
......@@ -138,6 +145,7 @@ Utilities for controlling the tracking (letter spacing) of an element.
{% endcapture %}
{% include example.html code=code %}
## Line Height
Utilities for controlling the leading (line height) of an element.
......@@ -150,6 +158,7 @@ Utilities for controlling the leading (line height) of an element.
{% endcapture %}
{% include example.html code=code %}
## Antialiasing
Utilities for controlling the font smoothing of an element.
......@@ -162,6 +171,7 @@ Use the `.antialiased` utility to render text using subpixel antialiasing or use
{% endcapture %}
{% include example.html code=code %}
## Markdown elements
When you can't use the CSS classes you want, or when you just want to directly use HTML tags, use `.markdown` as container. It can handle almost any HTML tag.
......
......@@ -3,12 +3,14 @@ title: Markdown
page-header: Markdown
---
# Who's that then?
Well, she turned me into a newt. Burn her! We want a shrubbery!! Well, I got better. Listen. Strange women lying in ponds distributing swords is no basis for a system of government. Supreme executive power derives from a mandate from the masses, not from some farcical aquatic ceremony.
Listen. __Strange women lying in ponds distributing swords is no basis for a system of government.__ *Supreme executive power derives from a mandate from the masses, not from some farcical aquatic ceremony.* The swallow may fly south with the sun, and the house martin or the plover may seek warmer climes in winter, yet these are not strangers to our land.
## Well, Mercia's a temperate zone!
You don't frighten us, English pig-dogs! Go and boil your bottoms, sons of a silly person! I blow my nose at you, so-called Ah-thoor Keeng, you and all your silly English K-n-n-n-n-n-n-n-niggits! A newt?
......@@ -17,6 +19,7 @@ You don't frighten us, English pig-dogs! Go and boil your bottoms, sons of a sil
2. I don't want to talk to you no more, you empty-headed animal food trough water! I fart in your general direction! Your mother was a hamster and your father smelt of elderberries! Now leave before I am forced to taunt you a second time!
3. We found them.
### What do you mean?
Oh! Come and see the violence inherent in the system! Help, help, I'm being repressed! The Lady of the Lake, her arm clad in the purest shimmering samite, held aloft Excalibur from the bosom of the water, signifying by divine providence that I, Arthur, was to carry Excalibur. That is why I am your king.
......@@ -47,26 +50,32 @@ Bloody Peasant! What a strange person. Burn her anyway! Camelot! You don't vote
You don't vote for kings. I dunno. Must be a king. How do you know she is a witch? Why? I don't want to talk to you no more, you empty-headed animal food trough water! I fart in your general direction! Your mother was a hamster and your father smelt of elderberries! Now leave before I am forced to taunt you a second time!
# Heading 1
Bloody Peasant! What do you mean? It's only a model. Well, Mercia's a temperate zone!
## Heading 2
Bloody Peasant! What do you mean? It's only a model. Well, Mercia's a temperate zone!
### Heading 3
Bloody Peasant! What do you mean? It's only a model. Well, Mercia's a temperate zone!
#### Heading 4
Bloody Peasant! What do you mean? It's only a model. Well, Mercia's a temperate zone!
##### Heading 5
Bloody Peasant! What do you mean? It's only a model. Well, Mercia's a temperate zone!
###### Heading 6
Bloody Peasant! What do you mean? It's only a model. Well, Mercia's a temperate zone!
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册