From d162b06c4c04f8e3f5a6eef2c9a7b0d3b6b383ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Kuna?= <1282324+codecalm@users.noreply.github.com> Date: Mon, 27 Feb 2023 01:21:44 +0100 Subject: [PATCH] New docs (#1492) --- README.md | 2 +- _config.yml | 9 +- .../_docs/colors.md => docs/base/colors.mdx | 23 +- docs/base/typography.mdx | 300 ++++ docs/components/alerts.mdx | 421 +++++ .../components/autosize.mdx | 10 +- docs/components/avatars.mdx | 172 ++ docs/components/badges.mdx | 129 ++ docs/components/breadcrumb.mdx | 107 ++ docs/components/buttons.mdx | 863 ++++++++++ docs/components/cards.mdx | 345 ++++ docs/components/carousel.mdx | 235 +++ docs/components/charts.mdx | 526 ++++++ .../countup.md => docs/components/countup.mdx | 125 +- docs/components/datagrid.mdx | 90 + .../divider.md => docs/components/divider.mdx | 43 +- docs/components/dropdowns.mdx | 245 +++ docs/components/dropzone.mdx | 63 + docs/components/empty.mdx | 103 ++ docs/components/icons.mdx | 120 ++ docs/components/inline-player.mdx | 31 + docs/components/modals.mdx | 224 +++ docs/components/placeholder.mdx | 272 +++ .../popover.md => docs/components/popover.mdx | 34 +- docs/components/progress.mdx | 92 + docs/components/progressbg.mdx | 16 + docs/components/range-slider.mdx | 17 + docs/components/ribbons.mdx | 151 ++ docs/components/spinners.mdx | 119 ++ docs/components/statuses.mdx | 284 ++++ docs/components/steps.mdx | 111 ++ docs/components/switch-icon.mdx | 155 ++ docs/components/tables.mdx | 410 +++++ docs/components/tabs.mdx | 243 +++ docs/components/timelines.mdx | 506 ++++++ docs/components/tinymce.mdx | 44 + docs/components/toasts.mdx | 73 + .../components/tooltips.mdx | 17 +- docs/components/tracking.mdx | 162 ++ docs/config.json | 1487 +++++++++++++++++ docs/forms/form-color-check.mdx | 179 ++ docs/forms/form-elements.mdx | 570 +++++++ docs/forms/form-fieldset.mdx | 44 + .../forms/form-helpers.mdx | 11 +- docs/forms/form-image-check.mdx | 162 ++ .../forms/form-input-mask.mdx | 13 +- docs/forms/form-selectboxes.mdx | 303 ++++ docs/forms/form-validation.mdx | 25 + docs/getting-started/browser-support.mdx | 20 + .../getting-started/customize.mdx | 3 +- .../getting-started/download.mdx | 22 +- docs/getting-started/faq.mdx | 23 + .../getting-started/index.mdx | 13 +- docs/icons/index.mdx | 103 ++ docs/layout/page-headers.mdx | 224 +++ docs/menu.json | 211 +++ docs/plugins/flags.mdx | 54 + docs/plugins/payments.mdx | 45 + docs/utilities/borders.mdx | 114 ++ docs/utilities/cursors.mdx | 92 + .../utilities/interactions.mdx | 13 +- src/pages/_data/menu.yml | 2 +- src/pages/_docs/alerts.md | 101 -- src/pages/_docs/avatars.md | 147 -- src/pages/_docs/badges.md | 89 - src/pages/_docs/borders.md | 72 - src/pages/_docs/breadcrumb.md | 45 - src/pages/_docs/browser-support.md | 21 - src/pages/_docs/buttons.md | 353 ---- src/pages/_docs/cards.md | 136 -- src/pages/_docs/carousel.md | 59 - src/pages/_docs/charts.md | 62 - src/pages/_docs/cursors.md | 76 - src/pages/_docs/datagrid.md | 10 - src/pages/_docs/dropdowns.md | 127 -- src/pages/_docs/dropzone.md | 27 - src/pages/_docs/empty.md | 34 - src/pages/_docs/flags.md | 48 - src/pages/_docs/form-color-check.md | 27 - src/pages/_docs/form-elements.md | 225 --- src/pages/_docs/form-fieldset.md | 11 - src/pages/_docs/form-image-check.md | 22 - src/pages/_docs/form-selectboxes.md | 23 - src/pages/_docs/form-validation.md | 20 - src/pages/_docs/icons.md | 53 - src/pages/_docs/index.html | 27 - src/pages/_docs/inline-player.md | 21 - src/pages/_docs/modals.md | 57 - src/pages/_docs/page-headers.md | 40 - src/pages/_docs/payments.md | 46 - src/pages/_docs/placeholder.md | 166 -- src/pages/_docs/progress.md | 69 - src/pages/_docs/progressbg.md | 13 - src/pages/_docs/range-slider.md | 150 -- src/pages/_docs/ribbons.md | 62 - src/pages/_docs/spinners.md | 87 - src/pages/_docs/statuses.md | 77 - src/pages/_docs/steps.md | 59 - src/pages/_docs/switch-icon.md | 31 - src/pages/_docs/tables.md | 118 -- src/pages/_docs/tabs.md | 66 - src/pages/_docs/timelines.md | 25 - src/pages/_docs/tinymce.md | 17 - src/pages/_docs/toasts.md | 39 - src/pages/_docs/tracking.md | 33 - src/pages/_docs/typography.md | 212 --- src/pages/_includes/layout/footer.html | 2 +- src/pages/_includes/redirect.html | 9 +- src/pages/docs/index.html | 5 + vercel.json | 42 + 110 files changed, 10504 insertions(+), 3382 deletions(-) rename src/pages/_docs/colors.md => docs/base/colors.mdx (61%) create mode 100644 docs/base/typography.mdx create mode 100644 docs/components/alerts.mdx rename src/pages/_docs/autosize.md => docs/components/autosize.mdx (67%) create mode 100644 docs/components/avatars.mdx create mode 100644 docs/components/badges.mdx create mode 100644 docs/components/breadcrumb.mdx create mode 100644 docs/components/buttons.mdx create mode 100644 docs/components/cards.mdx create mode 100644 docs/components/carousel.mdx create mode 100644 docs/components/charts.mdx rename src/pages/_docs/countup.md => docs/components/countup.mdx (53%) create mode 100644 docs/components/datagrid.mdx rename src/pages/_docs/divider.md => docs/components/divider.mdx (61%) create mode 100644 docs/components/dropdowns.mdx create mode 100644 docs/components/dropzone.mdx create mode 100644 docs/components/empty.mdx create mode 100644 docs/components/icons.mdx create mode 100644 docs/components/inline-player.mdx create mode 100644 docs/components/modals.mdx create mode 100644 docs/components/placeholder.mdx rename src/pages/_docs/popover.md => docs/components/popover.mdx (59%) create mode 100644 docs/components/progress.mdx create mode 100644 docs/components/progressbg.mdx create mode 100644 docs/components/range-slider.mdx create mode 100644 docs/components/ribbons.mdx create mode 100644 docs/components/spinners.mdx create mode 100644 docs/components/statuses.mdx create mode 100644 docs/components/steps.mdx create mode 100644 docs/components/switch-icon.mdx create mode 100644 docs/components/tables.mdx create mode 100644 docs/components/tabs.mdx create mode 100644 docs/components/timelines.mdx create mode 100644 docs/components/tinymce.mdx create mode 100644 docs/components/toasts.mdx rename src/pages/_docs/tooltips.md => docs/components/tooltips.mdx (85%) create mode 100644 docs/components/tracking.mdx create mode 100644 docs/config.json create mode 100644 docs/forms/form-color-check.mdx create mode 100644 docs/forms/form-elements.mdx create mode 100644 docs/forms/form-fieldset.mdx rename src/pages/_docs/form-helpers.md => docs/forms/form-helpers.mdx (82%) create mode 100644 docs/forms/form-image-check.mdx rename src/pages/_docs/input-mask.md => docs/forms/form-input-mask.mdx (54%) create mode 100644 docs/forms/form-selectboxes.mdx create mode 100644 docs/forms/form-validation.mdx create mode 100644 docs/getting-started/browser-support.mdx rename src/pages/_docs/customize.md => docs/getting-started/customize.mdx (95%) rename src/pages/_docs/download.md => docs/getting-started/download.mdx (56%) create mode 100644 docs/getting-started/faq.mdx rename src/pages/_docs/getting-started.md => docs/getting-started/index.mdx (77%) create mode 100644 docs/icons/index.mdx create mode 100644 docs/layout/page-headers.mdx create mode 100644 docs/menu.json create mode 100644 docs/plugins/flags.mdx create mode 100644 docs/plugins/payments.mdx create mode 100644 docs/utilities/borders.mdx create mode 100644 docs/utilities/cursors.mdx rename src/pages/_docs/interactions.md => docs/utilities/interactions.mdx (72%) delete mode 100644 src/pages/_docs/alerts.md delete mode 100644 src/pages/_docs/avatars.md delete mode 100644 src/pages/_docs/badges.md delete mode 100644 src/pages/_docs/borders.md delete mode 100644 src/pages/_docs/breadcrumb.md delete mode 100644 src/pages/_docs/browser-support.md delete mode 100644 src/pages/_docs/buttons.md delete mode 100644 src/pages/_docs/cards.md delete mode 100644 src/pages/_docs/carousel.md delete mode 100644 src/pages/_docs/charts.md delete mode 100644 src/pages/_docs/cursors.md delete mode 100644 src/pages/_docs/datagrid.md delete mode 100644 src/pages/_docs/dropdowns.md delete mode 100644 src/pages/_docs/dropzone.md delete mode 100644 src/pages/_docs/empty.md delete mode 100644 src/pages/_docs/flags.md delete mode 100644 src/pages/_docs/form-color-check.md delete mode 100644 src/pages/_docs/form-elements.md delete mode 100644 src/pages/_docs/form-fieldset.md delete mode 100644 src/pages/_docs/form-image-check.md delete mode 100644 src/pages/_docs/form-selectboxes.md delete mode 100644 src/pages/_docs/form-validation.md delete mode 100644 src/pages/_docs/icons.md delete mode 100644 src/pages/_docs/index.html delete mode 100644 src/pages/_docs/inline-player.md delete mode 100644 src/pages/_docs/modals.md delete mode 100644 src/pages/_docs/page-headers.md delete mode 100644 src/pages/_docs/payments.md delete mode 100644 src/pages/_docs/placeholder.md delete mode 100644 src/pages/_docs/progress.md delete mode 100644 src/pages/_docs/progressbg.md delete mode 100644 src/pages/_docs/range-slider.md delete mode 100644 src/pages/_docs/ribbons.md delete mode 100644 src/pages/_docs/spinners.md delete mode 100644 src/pages/_docs/statuses.md delete mode 100644 src/pages/_docs/steps.md delete mode 100644 src/pages/_docs/switch-icon.md delete mode 100644 src/pages/_docs/tables.md delete mode 100644 src/pages/_docs/tabs.md delete mode 100644 src/pages/_docs/timelines.md delete mode 100644 src/pages/_docs/tinymce.md delete mode 100644 src/pages/_docs/toasts.md delete mode 100644 src/pages/_docs/tracking.md delete mode 100644 src/pages/_docs/typography.md create mode 100644 src/pages/docs/index.html diff --git a/README.md b/README.md index 0552bf578..3835db695 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ We've created this admin panel for everyone who wants to create templates based ## 📖 Documentation -Documentation is available as a part of Tabler preview: https://preview.tabler.io/docs/ +Documentation is available as a part of Tabler preview: https://tabler.io/docs/ ## 🪴 Project Activity diff --git a/_config.yml b/_config.yml index fffa02be6..6a68e0fc4 100644 --- a/_config.yml +++ b/_config.yml @@ -22,6 +22,7 @@ github-sponsors-url: https://github.com/sponsors/codecalm changelog-url: https://github.com/tabler/tabler/releases sponsor-url: https://github.com/sponsors/codecalm preview-url: https://preview.tabler.io +docs-url: https://tabler.io/docs mapbox-key: pk.eyJ1IjoiY29kZWNhbG0iLCJhIjoiSzRiOVJvQSJ9.BUVkTT6IYs83xSUs4H7bjQ google-maps-key: AIzaSyAr5mRB4U1KRkVznIrDWEvZjroYcD202DI @@ -59,10 +60,6 @@ jekyll_tidy: compress_html: false ignore_env: development -collections: - docs: - output: true - defaults: - scope: type: "pages" @@ -73,10 +70,6 @@ defaults: type: "pages" values: layout: default - - scope: - type: "docs" - values: - layout: docs colors: blue: diff --git a/src/pages/_docs/colors.md b/docs/base/colors.mdx similarity index 61% rename from src/pages/_docs/colors.md rename to docs/base/colors.mdx index 67efcb950..60094a10a 100644 --- a/src/pages/_docs/colors.md +++ b/docs/base/colors.mdx @@ -1,20 +1,27 @@ --- title: Colors -menu: help.docs.content.colors -description: The choice of colors for a website or app interface has an big influence on how users interact with the product and what decisions they make. Harmonic colors can contribute to a nice first impression and encourage users to engage with your product, so it's a very important aspect of a successful design, which needs to be well thought out. -bootstrap-link: utilities/colors/ +description: The choice of colors for a website or app interface has an big influence on how users interact with the product and what decisions they make. Harmonic colors can contribute to a nice first impression and encourage users to engage with your product, so it's a very important aspect of a successful design, which needs to be well thought out. +bootstrapLink: utilities/colors/ --- +import config from '../config.json' ## Base colors -Choose one of the available colors from the basic color palette and make your design attractive for users. You can use the colors to customize the design of components, indicate different states or suggest actions you want users to take. +Choose one of the available colors from the basic color palette and make your design attractive for users. You can use the colors to customize the design of components, indicate different states or suggest actions you want users to take. -{% include example/colors-table.html %} + +## Light colors -## Light colors +All available colors can come in pastel shades, which are perfect for more subtle designs and can be easily combined with the basic palette to create eye-cathing designs. -All available colors can come in pastel shades, which are perfect for more subtle designs and can be easily combined with the basic palette to create eye-cathing designs. + -{% include example/colors-table.html light=true %} +## Gray palette + + + +## Social colors + + diff --git a/docs/base/typography.mdx b/docs/base/typography.mdx new file mode 100644 index 000000000..26d550df8 --- /dev/null +++ b/docs/base/typography.mdx @@ -0,0 +1,300 @@ +--- +title: Typography +description: Typography plays an important role in creating an attractive and clear interface design. Good typography will make the content easy to follow and improve the usability of your website. +bootstrapLink: content/typography/ +--- + +## Headings + +Use HTML headings to organize content on your website and make the structure clear and user-friendly. + +```html example vertical +

H1 Heading

+

H2 Heading

+

H3 Heading

+

H4 Heading

+
H5 Heading
+
H6 Heading
+``` + +```html +

H1 Heading

+

H2 Heading

+

H3 Heading

+

H4 Heading

+
H5 Heading
+
H6 Heading
+``` + +## Paragraphs + +Organize longer pieces of text into paragraphs using the `p` tag. + +```html example vertical centered columns={2} +
+

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

+

At vero eos et accusam et justo duo dolores et ea rebum.

+
+``` + +```html +

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

+

At vero eos et accusam et justo duo dolores et ea rebum.

+``` + +## Semantic text elements + +Use a variety of semantic text elements, depending of how you want to display particular fragments of content. + +```html example vertical separated columns={1} +
I1f8N
+
Bold
+
Citation
+
Hello World!
+
Deleted
+
Emphasis
+
Italic
+
Inserted
+
Ctrl + S
+
Highlighted
+
Strikethrough
+
Sample
+
Text Subscripted
+
Text Superscripted
+
+
Underline
+
x = y + 2
+``` + +```html +I18N +Bold +Citation +Hello World! +Deleted +Emphasis +Italic +Inserted +Ctrl + S +Highlighted +Strikethrough +Sample +Text Subscripted +Text Superscripted + +Underline +x = y + 2 +``` + +## Horizontal rules + +Use the `hr` tag to represent a thematic break between paragraphs within one section. + +```html example vertical centered columns={2} +
+

Lorem ipsum dolor sit amet, consectetur adipisicing elit. A atque ex excepturi fuga magnam nam reiciendis velit. Amet eius eos eveniet fuga in ipsa, ipsum voluptatum. Dolorem expedita quibusdam veniam?

+
+

Lorem ipsum dolor sit amet, consectetur adipisicing elit. A atque ex excepturi fuga magnam nam reiciendis velit. Amet eius eos eveniet fuga in ipsa, ipsum voluptatum. Dolorem expedita quibusdam veniam?

+
+``` + +```html +
+``` + +## Horizontal rules with label + +You can also add a label to a horizontal rule and align it as you see fit. + +```html code example vertical centered columns={2} +

+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +

+
+ Rule text +
+

+ At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +

+
+ Rule text +
+

+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. +

+
+ Rule text +
+

+ At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. +

+``` + +## Optimized for different alphabets + +Tabler has been optimized to correctly display content in any language. It supports most Asian, African and Middle Eastern languages. + +```html example vertical centered columns={2} +

汉字

+

日本語の表記体系

+

한글

+

Кириллица

+

Eλληνική

+

ქართული დამწერლობა

+

Հայերենի այբուբեն

+

الحروف العربية

+

אלפבית עברי

+

อักษรไทย

+``` + +```html +
Chinese
+

汉字

+ +
Japanese
+

日本語の表記体系

+ +
Korean
+

한글

+ +
Cyrillic
+

Кириллица

+ +
Greek
+

Eλληνική

+ +
Georgian
+

ქართული დამწერლობა

+ +
Armenian
+

Հայերենի այբուբեն

+ +
Arabic
+

الحروف العربية

+ +
Hebrew
+

אלפבית עברי

+ +
Thai
+

อักษรไทย

+``` + +## Text transform + +Transform the content of components with text capitalization classes. + +```html example vertical +
Lowercased text.
+
Uppercased text.
+
Capitalized text.
+``` + +```html +

Lowercased text.

+

Uppercased text.

+

Capitalized text.

+``` + +## Letter spacing + +Control the tracking (letter spacing) of an element and make it tight, wide or normal. + +```html example vertical +
Lorem ipsum dolor sit amet. Tight letter spacing.
+
Lorem ipsum dolor sit amet. Normal letter spacing.
+
Lorem ipsum dolor sit amet. Wide letter spacing.
+``` + +```html +

Lorem ipsum dolor sit amet. Tight letter spacing.

+

Lorem ipsum dolor sit amet. Normal letter spacing.

+

Lorem ipsum dolor sit amet. Wide letter spacing.

+``` + +## Line height + +Control the leading (line height) of an element. + +```html example +
+
+
+
+
Lorem ipsum dolor sit amet. Dolor sit amet.
+
+
+
+
+
+
+
Lorem ipsum dolor sit amet. Dolor sit amet.
+
+
+
+
+
+
+
Lorem ipsum dolor sit amet. Dolor sit amet.
+
+
+
+
+
+
+
Lorem ipsum dolor sit amet. Dolor sit amet.
+
+
+
+
+``` + +```html +

Lorem ipsum dolor sit amet. Dolor sit amet.

+

Lorem ipsum dolor sit amet. Dolor sit amet.

+

Lorem ipsum dolor sit amet. Dolor sit amet.

+

Lorem ipsum dolor sit amet. Dolor sit amet.

+``` + +## Antialiasing + +Control the font smoothing of an element. + +Use the `.antialiased` utility to render text using subpixel antialiasing or use the `.subpixel-antialiased` utility to remove antialiasing. + +```html code example +
Text with antialiasing
+
Text without antialiasing
+``` + +## Keyboard input + +Use the `` to indicate input that is typically entered via keyboard. + +```html example centered +
+ To edit settings, press ctrl + , or ctrl + C. +
+``` + +```html +To edit settings, press ctrl + , or ctrl + C. +``` + +## Markdown elements + +If you can't use the CSS classes you want or if you just want to use HTML tags, use the `.markdown` class in a container. It can handle almost any HTML tag. + +```html code example centered background="white" columns={2} height="30rem" +
+

Hello World

+

Lorem ipsum[1] dolor sit amet, consectetur adipiscing elit. Nulla accumsan, metus ultrices eleifend gravida, nulla nunc varius lectus, nec rutrum justo nibh eu lectus. Ut vulputate semper dui. Fusce erat odio, sollicitudin vel erat vel, interdum mattis neque. Subscript works as well!

+

Second level

+

Curabitur accumsan turpis pharetra augue tincidunt blandit. Quisque condimentum maximus mi, sit amet commodo arcu rutrum id. Proin pretium urna vel cursus venenatis. Suspendisse potenti. Etiam mattis sem rhoncus lacus dapibus facilisis. Donec at dignissim dui. Ut et neque nisl.

+
    +
  • In fermentum leo eu lectus mollis, quis dictum mi aliquet.
  • +
  • Morbi eu nulla lobortis, lobortis est in, fringilla felis.
  • +
  • Aliquam nec felis in sapien venenatis viverra fermentum nec lectus.
  • +
  • Ut non enim metus.
  • +
+
+``` diff --git a/docs/components/alerts.mdx b/docs/components/alerts.mdx new file mode 100644 index 000000000..67b48abcd --- /dev/null +++ b/docs/components/alerts.mdx @@ -0,0 +1,421 @@ +--- +title: Alerts +description: Alert messages are used to inform users of the status of their action and help them solve any problems that might have occurred. Good design of alert modals is very important for the overall user experience of a website or app. +bootstrapLink: components/alerts/ +--- + +## Default markup + +Depending on the information you need to convey, you can use one of the following types of alert messages - **success**, **info**, **warning** or **danger**. Using the right type of alert modal will help draw users' attention to the message and prompt them to take action. + +```html example + + + + +``` + +```html + +``` + +## Alert links + +Add a link to your alert message to redirect users to the details they need to complete or additional information they should read. + +```html example +
+ This is a danger alert — check it out! +
+``` + +```html + +``` + +## Dismissible alerts + +Add the `x` close button to make an alert modal dismissible. Thanks to that, your alert modal will disappear only once the user closes it. + +```html example + + + + +``` + +```html + +``` + +## Alerts with icons + +Add an icon to your alert modal to make it more user-friendly and help users easily identify the message. + +```html example + + + + +``` + +```html + + + + +``` + +## Alert with avatar + +Add an avatar to your alert modal to make it more personalized. + +```html code example + + + + +``` + +## Alert with buttons + +Add primary and secondary buttons to your alert modals if you want users to take a particular action based on the information included in the modal message. + +```html code example + + + + +``` + +## Important alerts + +If you want your alert to be really eye-catching, you can add a class `alert-important`. + +```html example + +``` + +```html + + + + +``` + diff --git a/src/pages/_docs/autosize.md b/docs/components/autosize.mdx similarity index 67% rename from src/pages/_docs/autosize.md rename to docs/components/autosize.mdx index 04233fc0a..0c7928e28 100644 --- a/src/pages/_docs/autosize.md +++ b/docs/components/autosize.mdx @@ -1,6 +1,5 @@ --- title: Autosize -menu: help.docs.plugins.autosize description: The autosize element will automatically adjust the textarea height and make it easier for users to follow as they type. libs: autosize --- @@ -9,10 +8,9 @@ To be able to use the autosize in your application you will need to install the ## Default markup -Add the autosize element to your input to make it automatically adjust to the length of a text as a user types it. +Add the autosize element to your input to make it automatically adjust to the length of a text as a user types it. -{% capture code %} +```html code example centered columns={1} scrollable -{% include ui/form/textarea-autosize.html %} -{% endcapture %} -{% include example.html code=code %} + +``` diff --git a/docs/components/avatars.mdx b/docs/components/avatars.mdx new file mode 100644 index 000000000..96dbd8c13 --- /dev/null +++ b/docs/components/avatars.mdx @@ -0,0 +1,172 @@ +--- +title: Avatars +description: Avatars help customise various elements of a user interface and make the product experience more personalised. They are often used in communication apps, collaboration tools and social media. +--- + +## Default markup + +Use the `avatar` class to add an avatar to your interface design for greater customisation. + +```html example centered separated code + +JL + +``` + +## Avatar image + +Set an image as the background to make users easy to indentify and create a personalised experience. + +```html example centered separated code + + + +``` + +## Initials + +You can also use initials instead of pictures. + +```html example centered separated code +AB +CD +EF +GH +IJ +``` + +## Avatar icons + +Apart from pictures and initials, you can also use icons to make the avatars more universal. + +```html example centered separated + + + + + + + + + + + + + + + + + + + + + + +``` + +```html + + + ... + +``` + +## Avatar initials color + +Customize the color of the avatars' background. You can click [here](colors) to see the list of available colors. + +```html example centered separated code +AB +CD +EF +GH +IJ +``` + +## Avatar size + +Using Bootstrap’s typical naming structure, you can create a standard avatar or scale it up or down to different sizes based on what you need. + +```html example centered separated code + + + + + + +``` + +## Avatar status + +Add a status indicator to your avatar to show, for instance, if a users is online or offline or indicate the number of messages they have received. + +```html example centered separated code + + + + + + + +SA + + + + + 5 + +``` + +## Avatar shape + +Change the shape of an avatar with the default Bootstrap image classes. You can make them round or square and change their border radius. + +```html example centered separated + + +AA + + +``` + +## Avatars list + +Create a list of avatars within one parent container. + +```html example centered separated code +
+ + JL + + + +
+``` + +## Stacked list + +Make the list stack once a certain number of avatars is reached to make it look clear and display well regardless of the screen size. + +```html example centered separated code +
+ EB + + + + + +8 +
+``` + +```html example centered separated code +
+ + + + SA + + + + +
+``` diff --git a/docs/components/badges.mdx b/docs/components/badges.mdx new file mode 100644 index 000000000..2206879b7 --- /dev/null +++ b/docs/components/badges.mdx @@ -0,0 +1,129 @@ +--- +title: Badges +description: Badges are small count and labeling components, which are used to add extra information to an interface element. You can use them to draw users' attention to a new element, notify about unread messages or provide any kind of additional info. +bootstrapLink: components/badge/ +--- + +## Table of content + +## Default markup + +The default badges are square and come in the basic set of colors. + +```html code example centered separated +Blue +Azure +Indigo +Purple +Pink +Red +Orange +Yellow +Lime +Green +Teal +Cyan +``` + +## Headings + +```html code example +

Example heading New

+

Example heading New

+

Example heading New

+

Example heading New

+
Example heading New
+
Example heading New
+``` + +## Outline badges + +```html code example centered separated +blue +azure +indigo +purple +pink +red +orange +yellow +lime +green +teal +cyan +``` + +## Pill badges + +Use the `.badge-pill` class if you want to create a badge with rounded corners. Its width will adjust to the label text. + +```html code example centered separated +1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +``` + +## Soft color badges + +You can create a soft colour variant of a corresponding contextual badge variation, to make it look more subtle. Click [here](colors) to see the list of available colors and choose ones that best suit your design. + +```html code example centered separated +Blue +Azure +Indigo +Purple +Pink +Red +Orange +Yellow +Lime +Green +Teal +Cyan +``` + +## Links + +Place the badge within an `` element if you want it to perform the function of a link and make it clickable. + +```html code example centered separated +Blue +Azure +Indigo +Purple +Pink +Red +Orange +Yellow +Lime +Green +Teal +Cyan +``` + +## Button with badge + +Badges can be used as part of links or buttons to provide a counter. + +```html example centered separated + + +``` + +```html + + +``` diff --git a/docs/components/breadcrumb.mdx b/docs/components/breadcrumb.mdx new file mode 100644 index 000000000..0ed060a5c --- /dev/null +++ b/docs/components/breadcrumb.mdx @@ -0,0 +1,107 @@ +--- +title: Breadcrumb +description: Breadcrumbs are used to show the current website or app location and reduce the number of actions users have to take. Thanks to breadcrumbs, they can easily navigate within the website hierarchy and better understand its structure. +bootstrapLink: components/breadcrumb/ +--- + +## Default markup + +Add the `:before` pseudo-element in `li` tags to use the default separators. The `active` modifier in a `li` tag will help you indicate the current page location and facilitate navigation within your website or app. + +```html code example centered + +``` + +## Breadcrumb variations + +If you wish to use different separators, modify the `$breadcrumb-variants` variable in the Tabler config. Depending on the aesthetics of your design, you can choose dots, bullets or arrows. + +```html code example centered + +``` + +```html code example centered + +``` + +```html code example centered + +``` + +## Breadcrumb in headers + +If you wish to use breadcrumbs in headers, place them above the headers. + +```html example vertical centered columns={3} + +``` + +```html + +``` diff --git a/docs/components/buttons.mdx b/docs/components/buttons.mdx new file mode 100644 index 000000000..890a7edd0 --- /dev/null +++ b/docs/components/buttons.mdx @@ -0,0 +1,863 @@ +--- +title: Buttons +description: Use button styles that best suit your designs and encourage users to take the desired actions. You can customize the button's properties to improve the user experience of your website or system, changing the size, shape, color and many more. +bootstrapLink: components/buttons/ +--- + +## Button tag + +As one of the most common elements of UI design, buttons have a very important function of engaging users with your website or app and guiding them in their actions. Use the `.btn` classes with the ` + + + +``` + +## Default button + +The standard button creates a white background and subtle hover animation. It's meant to look and behave as an interactive element of your page. + +```html example code centered separated +Link +``` + +## Button variations + +Use the button classes that correspond to the function of your button. The big range of available colors will help you show your buttons' purpose and make them easy to spot. + +```html example code centered separated +Primary +Secondary +Success +Warning +Danger +Info +Dark +Light +``` + +## Disabled buttons + +Make buttons look inactive to show that an action is possible once the user meets certain criteria, such as completing the required fields to submit a form. + +```html example code centered separated +Primary +Secondary +Success +Warning +Danger +Info +Dark +Light +``` + +## Color variations + +Choose the right color for your button to make it go well with your design and draw users' attention. Button colors can have a big influence on users' decisions, which is why it's important to choose them based on the intended purpose. + +```html example code centered separated +Blue +Azure +Indigo +Purple +Pink +Red +Orange +Yellow +Lime +Green +Teal +Cyan +``` + +## Ghost buttons + +Use the `.btn-ghost-*` class to make your button look simple yet aesthetically appealing. Ghost buttons help focus users' attention on the website's primary design, at the same time encouraging them to take action. + +```html example centered separated +Primary +Secondary +Success +Warning +Danger +Info +Dark + +``` + +```html +Primary +Secondary +Success +Warning +Danger +Info +Dark +Light +``` + +## Square buttons + +Use the `.btn-square` class to remove the border radius, if you want the corners of your button to be square rather than rounded. + +```html example centered separated +Square button +``` + +```html + + Square button + +``` + +## Pill buttons + +Add the `.btn-pill` class to your button to make it rounded and give it a modern and attractive look. + +```html example centered separated +Pill button +``` + +```html + + Pill button + +``` + +## Outline buttons + +Replace the default modifier class with the `.btn-outline-*` class, if you want to remove the color and the background of your button and give it a more subtle look. Outline buttons are perfect to use as secondary buttons, as they don't distract users from the main action. + +```html example centered separated +Primary +Secondary +Success +Warning +Danger +Info +Dark +Light +``` + +```html + + Primary + + + Secondary + + + Success + + + Warning + + + Danger + + + Info + + + Dark + + + Light + +``` + +## Button size + +Add `.btn-lg` or `.btn-sm` to change the size of your button and differentiate those which should have primary focus from those of secondary importance. Adapt the button size to your design and encourage users to take actions. + +```html code example centered separated + + +``` + +```html code example centered separated + + +``` + +## Buttons with icons + +Label your button with text and add an icon to communiacate the action and make it easy to identify for users. Icons are easily recognized and improve the aesthetics of your button design, giving it a modern and atractive look. + +Icons can be found [**here**](/docs/icons.html#icons) + +```html example centered separated + + + + + + +``` + +```html + + + + + + +``` + +## Social buttons + +You can use the icons of popular social networking sites, which users are familiar with. Thanks to buttons with social media icons users can share content or follow a website with just one click, without leaving the website. + +```html example centered separated + + + + Facebook + + + + Twitter + + + + Google + + + + + Youtube + + + + Vimeo + + + + + + + Dribbble + + + + Github + + + + + + Instagram + + + + + + Pinterest + + + + VK + + + + + + RSS + + + + + Flickr + + + + + Bitbucket + + + + + + Tabler +``` + +```html + + + ... + Facebook + + + + ... + Twitter + + + + ... + Google + + + + ... + Youtube + + + + ... + Vimeo + + + + ... + Dribbble + + + + ... + Github + + + + ... + Instagram + + + + ... + Pinterest + + + + ... + VK + + + + ... + RSS + + + + ... + Flickr + + + + ... + Bitbucket + + + + ... + Tabler + +``` + +You can also add an icon without the name of a social networking site, if you want to display more buttons on a small space. + +```html example centered separated + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +```html + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + +``` + +## Icon buttons + +Add the `.btn-icon` class to remove unnecessary padding from your button and use an icon without any additional label. Thanks to that, you can save space and make the action easy to recognize for international users. + +```html example centered separated + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +```html + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + + + + ... + +``` + +## Dropdown buttons + +Create a dropdown button that will encourage users to click for more options. You can add a label with an icon or remove the label and add an icon on its own if you want to save space. Choose the option that will best suit your design and improve the user experience. + +```html example centered separated + + + +``` + +```html + + + +``` + +## Loading buttons + +Add the `.btn-loading` class to show a button's loading state, which can be useful in the case of operations that take longer to process. Thanks to that, users will be aware of the current state of their action and won't give it up before it's finished. + +```html example centered separated +Button +Loading button with loooong content +``` + +```html + + Button + + + Loading button with loooong content + +``` + +```html example + Button +``` + +```html + + + Button + +``` + +## List of buttons + +Create a list of buttons using the `.btn-list` container to display different actions a user can take. If you add aditional styling, such as colours, you will be able to focus users' attention on a particular action or suggest the result. + +```html code example vertical centered columns={3} + +``` + +If the list is long, it will be wrapped and some buttons will be moved to the next line, keeping them all evenly spaced. + +```html code example centered + +``` + +Use the `.text-center` or the `.text-end` modifiers to change the buttons' alignment and place them where they suit best. + +```html code example vertical centered columns={3} + +``` + +```html code example vertical centered columns={3} + +``` + +```html code example vertical centered columns={3} + +``` + +## Buttons with avatars + +Use buttons with avatars to simplify the process of interaction and make your design more personalized. Buttons can contain avatars and labels or only avatars, if displayed on a smaller space. + +```html example centered separated + Avatar + Avatar + Avatar +``` + +```html + + Avatar + + + Avatar + + + Avatar + +``` diff --git a/docs/components/cards.mdx b/docs/components/cards.mdx new file mode 100644 index 000000000..8212a34ef --- /dev/null +++ b/docs/components/cards.mdx @@ -0,0 +1,345 @@ +--- +title: Cards +description: Cards are flexible user interface elements, which help organize content into meaningful sections and make it easier to display on different screen sizes. Cards contain various smaller components, such as images, text, links and buttons and may act as an entry to more detailed information, helping users scan the page quickly and find the most relevant content. +bootstrapLink: components/card/ +--- + +## Table of contents + +## Default card + +Use the `.card` and `.card-body` classes to create a card and use it as the basis for a more advanced card design. A card is a perfect way to organize content and make it look neat and tidy. + +```html example code centered columns={1} +
+
+

This is some text within a card body.

+
+
+``` + +## Card padding + +You can change the padding of a newly created card. To do it, use the `.card-sm`, `.card-md` or `.card-lg` classes. + +Cards with the `.card-sm` class are well suited for small items such as widgets, etc., while the `.card-lg` class can be used for large blocks of text. Padding will be automatically reduced on small devices, to fit the screen size. + +```html example vertical centered separated height={500} +
+
+ This is some text within a card body. +
+
+
+
+ This is some text within a card body. +
+
+
+
+ This is some text within a card body. +
+
+
+
+ This is some text within a card body. +
+
+``` + +```html +
...
+
...
+
...
+
...
+``` + +## Card with title + +Add a title to your card by including the `.card-title` class within `.card-body`. You can also place the title inside the `.card-header` element to separate the title from the content with a horizontal line. + +```html code example vertical centered separated height={400} +
+
+

Card title

+

This is some text within a card body.

+
+
+
+
+

Card title

+
+
+

This is some text within a card body.

+
+
+``` + +## Card with title and image + +To create a more visually appealing card, add a title and an image. Thanks to that, the card will go well with your interface design and draw users' attention. + +```html example centered columns={1} height={500} code +
+ +
+
+

Card with title and image

+

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aperiam deleniti fugit incidunt, iste, itaque minima + neque pariatur perferendis sed suscipit velit vitae voluptatem.

+
+
+``` + +## Blog post card + +Add an image to your blog post card to make it eye-catching. You can do it by adding the image in the `.card-img-top` class. Thanks to the `.d-flex` and `.flex-column` classes within `.card-body`, the author details will be displayed at the bottom of the card. + +```html example centered columns={1} height={600} code +
+ + + +
+

How do you know she is a witch?

+
Are you suggesting that coconuts migrate? No, no, no! Yes, yes. A bit. But she's got a wart. You ...
+
+ +
+ Maryjo Lebarree +
3 days ago
+
+ +
+
+
+``` + +## Row deck + +Add the `.row-deck` class to `.row`, if you want to display several cards next to one another. Thanks to that, they will all have the same height. + +```html code example centered +
+
+
+
Short content
+
+
+
+
+
Extra long content of card. Lorem ipsum dolor sit amet, consetetur sadipscing elitr
+
+
+
+
+
Short content
+
+
+
+``` + +## Post card with aside image + +You can also add an image on the left side of the card. To do it, add the `.card-aside` class to the element with the `.card` class. Then add the image in the `.card-aside-column` element and it will be automatically centered and scaled to the right size. + +```html example columns={2} centered height={400} code +
+
+
+ + Card side image + +
+
+
+

Shut up!

+
Burn her! How do you know she is a witch? You don't frighten us, English pig-dogs! Go and boil yo...
+
+ +
+ Egan Poetz +
3 days ago
+
+ +
+
+
+
+
+``` + +## Color variations + +Add a status color to your card, either at the top or on the side of the card, to customise it and make it more eye-catching. + +```html example columns={2} centered height={400} +
+
+
+
+
+

Card with top status

+

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aperiam deleniti fugit incidunt, iste, itaque minima + neque pariatur perferendis sed suscipit velit vitae voluptatem.

+
+
+
+
+
+
+
+

Card with side status

+

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aperiam deleniti fugit incidunt, iste, itaque minima + neque pariatur perferendis sed suscipit velit vitae voluptatem.

+
+
+
+
+``` + +```html +
+
+
+

Card with top status

+

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aperiam deleniti fugit incidunt, iste, itaque minima + neque pariatur perferendis sed suscipit velit vitae voluptatem.

+
+
+
+
+
+

Card with side status

+

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aperiam deleniti fugit incidunt, iste, itaque minima + neque pariatur perferendis sed suscipit velit vitae voluptatem.

+
+
+``` + +## Stacked card + +Use the `card-stacked` class to stack up multiple cards, if you want to save screen space or create a visually appealing effect. + +```html code example columns={1} centered height={300} +
+
+

Stacked card

+

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aperiam deleniti fugit incidunt, iste, itaque minima + neque pariatur perferendis sed suscipit velit vitae voluptatem.

+
+
+``` + +## Tabbed card + +Organize multiple cards into tabs to be able to display more content in a well-organized way and allow users to alternate between them easily. + +```html example columns={2} centered height={400} +
+ +
+
+
+
Content of tab #1
+

+ Lorem ipsum dolor sit amet, consectetur adipisicing elit. Adipisci, alias aliquid distinctio dolorem expedita, fugiat hic magni molestiae molestias odit. +

+
+
+
+
+
Content of tab #2
+

+ Lorem ipsum dolor sit amet, consectetur adipisicing elit. Adipisci, alias aliquid distinctio dolorem expedita, fugiat hic magni molestiae molestias odit. +

+
+
+
+
+
Content of tab #3
+

+ Lorem ipsum dolor sit amet, consectetur adipisicing elit. Adipisci, alias aliquid distinctio dolorem expedita, fugiat hic magni molestiae molestias odit. +

+
+
+
+
+
Content of tab #4
+

+ Lorem ipsum dolor sit amet, consectetur adipisicing elit. Adipisci, alias aliquid distinctio dolorem expedita, fugiat hic magni molestiae molestias odit. +

+
+
+
+
+``` + +```html + +
+ + +
+ +
+
+
Content of tab #1
+

+ Lorem ipsum dolor sit amet, consectetur adipisicing elit. Adipisci, alias aliquid distinctio dolorem expedita, fugiat hic magni molestiae molestias odit. +

+
+
+ +
+
+
Content of tab #2
+

+ Lorem ipsum dolor sit amet, consectetur adipisicing elit. Adipisci, alias aliquid distinctio dolorem expedita, fugiat hic magni molestiae molestias odit. +

+
+
+ +
+
+
Content of tab #3
+

+ Lorem ipsum dolor sit amet, consectetur adipisicing elit. Adipisci, alias aliquid distinctio dolorem expedita, fugiat hic magni molestiae molestias odit. +

+
+
+ +
+
+
Content of tab #4
+

+ Lorem ipsum dolor sit amet, consectetur adipisicing elit. Adipisci, alias aliquid distinctio dolorem expedita, fugiat hic magni molestiae molestias odit. +

+
+
+
+
+``` + diff --git a/docs/components/carousel.mdx b/docs/components/carousel.mdx new file mode 100644 index 000000000..4dd38318a --- /dev/null +++ b/docs/components/carousel.mdx @@ -0,0 +1,235 @@ +--- +title: Carousel +description: A carousel is used to display multiple pieces of visual content without taking up too much space. Carousels eliminate the need to scroll down the page to see all content and are a popular method of displaying marketing information. +bootstrapLink: components/carousel/ +--- + +## Default markup + +Use a carousel to make your website design more visually appealing for users. In the default carousel design, respective elements slide automatically and users can go to the next slide by clicking an arrow. + +```html code example centered columns={2} height="35rem" + +``` + +## Dots indicators + +You can replace the standard indicators with dots. Just add the `carousel-indicators-dot` class to your carousel: + +```html code example centered columns={2} height="35rem" + +``` + +## Thumb indicators + +The syntax is similar with thumbnails. Add class `carousel-indicators-thumb` and add `background-image` to element `[data-bs-target]`. Default thumbnails have an aspect ratio of 1:1. To change this use `ratio` utils. + +```html example code centered columns={2} height="35rem" + +``` + +## Vertical indicators + +To make the indicators go to the right side, add the `carousel-indicators-vertical` class. You can combine it with other classes that are responsible for dots or thumbnails. + +```html code example centered columns={2} height="35rem" + +``` + +Likewise, you can add thumbnails on the right side: + +```html code example centered columns={2} height="35rem" + +``` + +## Carousel with captions + +Add captions to your slides easily with the `.carousel-caption` element within any `.carousel-item`. To make the text more readable on the image you can add `carousel-caption-background` which will add a black overlay over the image. + +```html code example centered columns={2} height="35rem" + +``` diff --git a/docs/components/charts.mdx b/docs/components/charts.mdx new file mode 100644 index 000000000..d7ec9b51d --- /dev/null +++ b/docs/components/charts.mdx @@ -0,0 +1,526 @@ +--- +title: Charts +libs: apexcharts +description: Tabler uses ApexCharts - a free and open-source modern charting library that helps developers to create beautiful and interactive visualizations for web pages. +--- + +To be able to use the charts in your application you will need to install the apexcharts dependency with `npm install apexcharts`. + +See also the [ApexCharts](https://apexcharts.com/) documentation. + +## Line Chart + +Line charts are a typical pictorial representation that depicts trends and behaviors over time. + +```html example code centered columns={2} height="25rem" +
+
+
+
+
+ + + +``` + +## Area Chart + +Area charts are used to represent quantitative variations. + +```html example code centered columns={2} height="25rem" +
+
+
+
+
+ + + +``` + +## Bar Chart + +A bar chart is the best tool for displaying comparisons between categories of data. + +```html example code centered columns={2} height="25rem" +
+
+
+
+
+ + + +``` + +## Pie Chart + +Pie charts are an instrumental visualization tool useful in expressing data and information in terms of percentages, ratio. + +```html example code centered columns={2} height="25rem" +
+
+
+
+
+ + + +``` + +## Heatmap Chart + +Heatmap is a visualization tool that employs color the way a bar chart employs height and width in representing data. + +```html example code centered columns={2} height="25rem" +
+
+
+
+
+ + + +``` + +## Advanced example + +```html example code centered columns={2} height="25rem" +
+
+
+
+
+ + + +``` diff --git a/src/pages/_docs/countup.md b/docs/components/countup.mdx similarity index 53% rename from src/pages/_docs/countup.md rename to docs/components/countup.mdx index 3827ced76..ad356fdfe 100644 --- a/src/pages/_docs/countup.md +++ b/docs/components/countup.mdx @@ -1,7 +1,6 @@ --- title: Countup -description: A countup element is used to display numerical data in an interesting way and make the interface more interactive. All the available options can be found [here](https://inorganik.github.io/countUp.js/) -menu: help.docs.components.countup +description: A countup element is used to display numerical data in an interesting way and make the interface more interactive. libs: countup --- @@ -11,125 +10,127 @@ To be able to use the countup in your application you will need to install the c To create a countup, add `data-countup` to any HTML text tag and specify the number which is to be reached. The animation will be triggered as soon as the number enters the viewport. -{% capture code %} -

30000

-{% endcapture %} -{% include example.html code=code %} +```html code example + +

30000

+``` ## Duration Set the `duration` to determine how long the animation should take. By default, the duration is set to 2 seconds, but you can modify it as you wish. -{% capture code %} -

30000

-

30000

-

30000

-{% endcapture %} -{% include example.html code=code %} +```html code example + +

30000

+

30000

+

30000

+``` ## Starting value -By default the countup will start from zero. If you want to set a different start value use `startVal`. +By default the countup will start from zero. If you want to set a different start value use `startVal`. You can also set the start value to be greater than the final value, so that it counts down instead of up. -{% capture code %} +```html code example + +

30000

30000

-{% endcapture %} -{% include example.html code=code %} - +``` ## Decimal places Set how many decimal numbers should be displayed using `decimalPlaces`. -{% capture code %} -

3.123

-

3.123

-

3.123

-

3.123

-{% endcapture %} -{% include example.html code=code %} +```html code example + +

3.123

+

3.123

+

3.123

+

3.123

+``` ## Easing Disable easing using `"useEasing": false`. Easing is set to `true` by default, so that the animation speed changes over the course of its duration. -{% capture code %} -

30000

-

30000

-{% endcapture %} -{% include example.html code=code %} +```html code example + +

30000

+

30000

+``` ## Use grouping Disable grouping using `"useGrouping": false`. Grouping is set to `true` by default and the default group separator is a comma. -{% capture code %} -

30000

-

30000

-{% endcapture %} -{% include example.html code=code %} +```html code example + +

30000

+

30000

+``` ## Separator You can change the default comma group separator using `separator` and specifying the one you wish to use. -{% capture code %} -

3000000

-

3000000

-

3000000

-

3000000

-{% endcapture %} -{% include example.html code=code %} +```html code example + +

3000000

+

3000000

+

3000000

+

3000000

+``` ## Decimal separator You can also change the decimal separator which is set to a full stop by default. To do it, use `decimal` and specify the decimal separator of your choice. -{% capture code %} -

3.12

-

3.12

-

3.12

-

3.12

-{% endcapture %} -{% include example.html code=code %} +```html code example + +

3.12

+

3.12

+

3.12

+

3.12

+``` ## Prefix Set the countup prefix using `prefix` and specifying the prefix you want to add, for instance a currency symbol. -{% capture code %} -

30000

-

30000

-

30000

-{% endcapture %} -{% include example.html code=code %} +```html code example + +

30000

+

30000

+

30000

+``` ## Suffix Set the countup suffix using `suffix`. -{% capture code %} +```html code example + +

30

-

30

-

30

-{% endcapture %} -{% include example.html code=code %} +

30

+

30

+``` Of course you can mix all of these: -{% capture code %} +```html code example + +

64547834.76

-{% endcapture %} -{% include example.html code=code %} +``` For more advanced features of countups, click [**here**](https://inorganik.github.io/countUp.js/) and see what more you can do. diff --git a/docs/components/datagrid.mdx b/docs/components/datagrid.mdx new file mode 100644 index 000000000..96c2576c8 --- /dev/null +++ b/docs/components/datagrid.mdx @@ -0,0 +1,90 @@ +--- +title: Data grid +description: Use the data grid component to display detailed information about your product. The data is displayed as a column of items consisting of a title and content. +--- + +```html example vcentered height="22rem" +
+
+
Registrar
+
Third Party
+
+
+
Nameservers
+
Third Party
+
+
+
Port number
+
3306
+
+
+
Expiration date
+
+
+
+
Creator
+
+
+ + Paweł Kuna +
+
+
+
+
Age
+
15 days
+
+
+
Edge network
+
+ + Active + +
+
+
+
Avatars list
+
+
+ + JL + + + + +3 +
+
+
+
+
Checkbox
+
+ +
+
+
+
Icon
+
+ + + + + Checked +
+
+
+
Form control
+
+ +
+
+
+
Longer description
+
+ Lorem ipsum dolor sit amet, consectetur adipisicing elit. +
+
+
+``` diff --git a/src/pages/_docs/divider.md b/docs/components/divider.mdx similarity index 61% rename from src/pages/_docs/divider.md rename to docs/components/divider.mdx index 0f94d58c9..a3f42b2d5 100644 --- a/src/pages/_docs/divider.md +++ b/docs/components/divider.mdx @@ -1,70 +1,63 @@ --- title: Divider -description: Dividers help organize content and make the interface layout clear and uncluttered. Greater clarity adds up to better user experience and enhanced interaction with a website or app. -bootstrap-link: components/dropdowns/#dividers -menu: help.docs.components.divider +description: Dividers help organize content and make the interface layout clear and uncluttered. Greater clarity adds up to better user experience and enhanced interaction with a website or app. +bootstrapLink: components/dropdowns/#dividers --- - ## Default markup -Use dividers to visually separate content into parts. You can use a line only or add text that will be centered by default. +Use dividers to visually separate content into parts. You can use a line only or add text that will be centered by default. -{% capture code %} +```html code example

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Alias, dolore dolores doloribus est ex.

-{% include ui/hr.html text="See also" %} +
See also

Dicta error hic illo iure necessitatibus nihil officiis omnis perferendis, praesentium repellendus rerum, saepe sed, sit!

-{% endcapture %} -{% include example.html code=code wrapper="demo-dividers" %} - +``` ## Text position You can modify the position of the text which is to be included in a separator and make it left- or right-aligned. Otherwise, the text will remain centered. -{% capture code %} +```html code example

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Alias, dolore dolores doloribus est ex.

-{% include ui/hr.html text="Left divider" position="left" %} +
Left divider

Dicta error hic illo iure necessitatibus nihil officiis omnis perferendis, praesentium repellendus rerum, saepe sed, sit!

-{% include ui/hr.html text="Centered divider" %} +
Centered divider

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Alias, dolore dolores doloribus est ex.

-{% include ui/hr.html text="Right divider" position="right" %} +
Right divider

Dicta error hic illo iure necessitatibus nihil officiis omnis perferendis, praesentium repellendus rerum, saepe sed, sit!

-{% endcapture %} -{% include example.html code=code wrapper="demo-dividers" %} - +``` ## Divider color -Customize the color of dividers to make them go well with your design. Click [here]({% docs_url colors %}) to see the list of available colors. +Customize the color of dividers to make them go well with your design. Click [here](colors) to see the list of available colors. -{% capture code %} +```html code example

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Alias, dolore dolores doloribus est ex.

-{% include ui/hr.html text="Green divider" color="green" %} +
Green divider

Dicta error hic illo iure necessitatibus nihil officiis omnis perferendis, praesentium repellendus rerum, saepe sed, sit!

-{% include ui/hr.html text="Red divider" color="red" %} +
Red divider

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Alias, dolore dolores doloribus est ex.

-{% include ui/hr.html text="Primary divider" color="primary" %} +
Primary divider

- Dicta error hic illo iure necessitatibus nihil officiis omnis perferendis, praesentium repellendus rerum, saepe sed, sit! + Dicta error hic illo iure necessitatibus nihil officiis omnis perferendis, praesentium repellendus rerum, saepe sed, sit!

-{% endcapture %} -{% include example.html code=code wrapper="demo-dividers" %} +``` diff --git a/docs/components/dropdowns.mdx b/docs/components/dropdowns.mdx new file mode 100644 index 000000000..a9860889c --- /dev/null +++ b/docs/components/dropdowns.mdx @@ -0,0 +1,245 @@ +--- +title: Dropdowns +description: Use dropdowns to display lists of options or include more positions in a menu without overwhelming users with too many buttons and long lists. Dropdowns facilitate users' interaction with your website or software and make your design look clear. +bootstrapLink: components/dropdowns +--- + +## Default dropdown + +With small markup changes, you can turn any `.btn` into a dropdown toggle and use it to display more options for users to choose from. Start with the default dropdown and then use additional classes to make your dropdown more user-friendly. + +```html example code height="20rem" + +``` + +## Dropdown divider + +Use dropdown dividers to separate groups of dropdown items for greater clarity. + +```html example code height="20rem" + +``` + +## Active state + +Make a dropdown item look active, so that it highlights when a user hovers over a given option. + +```html example code height="20rem" + +``` + +## Disabled state + +Make a dropdown item look disabled to display options which are currently not available but can activate once certain conditions are met. + +```html code example height="20rem" + +``` + +## Dropdown header + +Add a dropdown header to group dropdown items into sections and name them accordingly. + +```html code example height="20rem" + +``` + +## Dropdown with icons + +Use icons in your dropdowns to add more visual content and make the options easy to identify for users. + +```html code example height="20rem" + +``` + +## Dropdown with arrow + +Add an arrow that points at the dropdown button. + +```html code example height="20rem" + +``` + +## Dropdown with badge + +Add a badge to your dropdown items to show additional information related to an item or distinguish it from other elements. + +```html code example height="20rem" + +``` + +## Dropdown with checkboxes + +Use dropdowns with checkboxes to allow users to select options from a predefined list. Dropdowns with checkboxes are particularly useful for filtering. + +```html code example height="20rem" + +``` + +## Dark dropdown + +Make your dropdown suit the dark mode of your website or software. + +```html code example height="20rem" + +``` + +## Dropdown with card content + +Use a dropdown with card content to make it easy for users to get more information on a given subject and avoid ovewhelming them with too much content at once. + +```html example height="35rem" + +``` diff --git a/docs/components/dropzone.mdx b/docs/components/dropzone.mdx new file mode 100644 index 000000000..f23dc14a3 --- /dev/null +++ b/docs/components/dropzone.mdx @@ -0,0 +1,63 @@ +--- +title: Dropzone +libs: dropzone +description: Dropzone is a simple JavaScript library that helps you add file drag and drop functionality to your web forms. It is one of the most popular drag and drop library on the web and is used by millions of people. +--- + +## Default Dropzone + +```html example code vendors height="240px" +
+
+ +
+
+ + + + +``` + +## Add multiple files + +```html example code vendors height="240px" +
+
+ +
+
+ + + + +``` + +## Custom Dropzone + +```html example code vendors height="240px" +
+
+ +
+
+

Your text here

+ Your custom description here +
+
+ + + + +``` diff --git a/docs/components/empty.mdx b/docs/components/empty.mdx new file mode 100644 index 000000000..f1bbacc65 --- /dev/null +++ b/docs/components/empty.mdx @@ -0,0 +1,103 @@ +--- +title: Empty states +description: Empty states or blank pages are commonly used as placeholders for first-use, empty data or error screens. Their aim is to engage users when there is no content to display and that is why their design is extremely important from the point of view of the user experience of your website or app. +--- + +## Default markup + +Use the default empty state to engage users in the critical moments of their experience with your website or app. A good empty state screen should let users know what is happening and what they should do next as well as encourage them to take action. + +```html code example +
+
+ + + + + + + +
+

No results found

+

+ Try adjusting your search or filter to find what you're looking for. +

+ +
+``` + +## Empty state with illustration + +Make your empty state screen more attractive and engaging by adding an illustration. Thanks to a more personalized design, you will improve your brand image and make your website or app more user friendly. + +```html code example +
+
+
+

Invoices are managed from here

+

+ Try adjusting your search or filter to find what you're looking for. +

+ +
+``` + +## Empty state with header + +Instead of adding an icon or illustration you can simply give the text: + +```html example +
+
404
+

Oops… You just found an error page

+

+ Try adjusting your search or filter to find what you're looking for. +

+ +
+``` + +```html +
+
404
+

Oops… You just found an error page

+

+ Try adjusting your search or filter to find what you're looking for. +

+ +
+``` diff --git a/docs/components/icons.mdx b/docs/components/icons.mdx new file mode 100644 index 000000000..7ad31ffd8 --- /dev/null +++ b/docs/components/icons.mdx @@ -0,0 +1,120 @@ +--- +title: Icons +description: Use one of over 3000 icons created specifically for Tabler and make your dashboard look even more attractive. All icons are under MIT license, so you can use them without any problem both in private and commercial projects. +banner: icons +--- + +## Base icon + +```html code example centered separated + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +## Filled icons + +```html code example centered separated + + + + + + + + + + + + + + + + + + + +``` + +## Icon colors + +```html example code centered separated + + + + + + + + + + + + + + + + + + + + + + + + +``` + +## Icon animations + +```html example centered separated + + + + + + + + + + + + + +``` + +```html + +... + + +... + + +... +``` diff --git a/docs/components/inline-player.mdx b/docs/components/inline-player.mdx new file mode 100644 index 000000000..8c9a74a54 --- /dev/null +++ b/docs/components/inline-player.mdx @@ -0,0 +1,31 @@ +--- +title: Inline player +libs: plyr +description: A simple, lightweight, accessible and customizable HTML5, YouTube and Vimeo media player that supports modern browsers. +--- + +## Sample demo + +```html example code vendors +
+ + + +``` + +## Vimeo file + +```html example code vendors +
+ + + +``` diff --git a/docs/components/modals.mdx b/docs/components/modals.mdx new file mode 100644 index 000000000..04c7604b8 --- /dev/null +++ b/docs/components/modals.mdx @@ -0,0 +1,224 @@ +--- +title: Modals +description: Use Bootstrap’s JavaScript modal plugin to add dialogs to your site for lightboxes, user notifications, or completely custom content. +--- + +## Table of contents + +## Default markup + +```html example code centered height="30rem" + + + +``` + +## Prompt and alert + +```html example code centered height="30rem" + + + +``` + +```html example code centered height="30rem" + + + +``` + +## Modal with form + +```html example code centered height="30rem" + + + +``` diff --git a/docs/components/placeholder.mdx b/docs/components/placeholder.mdx new file mode 100644 index 000000000..8779e5527 --- /dev/null +++ b/docs/components/placeholder.mdx @@ -0,0 +1,272 @@ +--- +title: Placeholder +description: Placeholder is used to reserve space for content that soon will appear in a layout. +redirect_from: + - /docs/skeleton.html +--- + +## Placeholder line + +Placeholder lines can contain have lines of text. Their length is different and depends on the `col-` class. + +```html code example columns={1} +
+
+
+
+``` + +However, it may be useful, however, to specify the full width in order to fit the content more effectively. + +```html code example columns={1} +
+
+
+
+``` + +You can also move the lines to right or to center: + +```html code example columns={1} +
+
+
+
+
+
+
+
+
+
+``` + +## Placeholder heading + +A placeholder can contain also a header element looks like header: + +```html code example columns={1} +
+
+
+``` + +## Placeholder avatar + +You can make your placeholder item look like an avatar. + +```html code example columns={1} +
+
+
+
+
+
+
+
+
+``` + +The size of avatars is exactly the same as a regular avatar. + +```html code example centered separated +
+
+
+
+
+
+``` + +## Placeholder image + +You can use a placeholder, which will look like a picture. You can use the `ratio` component, and get the image in the right proportions. + +You can also use the `ratio` component, and get the image in the right proportions. + +```html code example columns={1} +
+
+
+
+
+
+
+
+
+
+
+
+``` + +## Placeholder color + +By default, the `placeholder` uses `currentColor`. This can be overridden with a custom color or utility class. + +```html example columns={1} + + + + + + + + + +``` + +```html + + + + + + + + + + +``` + +## Placeholder sizing + +The size of `.placeholders` are based on the typographic style of the parent element. Customize them with sizing modifiers: `.placeholder-lg`, `.placeholder-sm`, or `.placeholder-xs`. + +```html code example columns={1} + + + + +``` + +## Animation + +Animate placeholders with `.placeholder-glow` or `.placeholder-wave` to better convey the perception of something being actively loaded. + +```html code example columns={1} +

+ +

+

+ +

+``` + +## Live examples + +See in the following examples how else you can use the placeholder component + +```html code example columns={1} height={1000} separated vertical +
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    +
  • +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
  • +
  • +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
  • +
  • +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
  • +
  • +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    +
  • +
+
+``` diff --git a/src/pages/_docs/popover.md b/docs/components/popover.mdx similarity index 59% rename from src/pages/_docs/popover.md rename to docs/components/popover.mdx index 9f4394df2..48a8a8624 100644 --- a/src/pages/_docs/popover.md +++ b/docs/components/popover.mdx @@ -1,25 +1,29 @@ --- title: Popovers description: Popovers are used to provide additional information on elements where a simple tooltip is not sufficient. -bootstrap-link: components/popovers -menu: help.docs.components.popover +bootstrapLink: components/popovers --- - ## Default markup To create a default popover use: -{% capture code %} +```html code example centered -{% endcapture %} -{% include example.html code=code %} +``` ## Four directions Four options are available: `top`, `right`, `bottom`, and `left` aligned. Directions are mirrored when using Bootstrap in RTL. -{% capture code %} +```html example centered separated + + + + +``` + +```html @@ -32,14 +36,20 @@ Popover on bottom -{% endcapture %} -{% include example.html code=code %} +``` ## Popover on hover Popover can be triggered `manual`, with a `click` and on `focus` and on `hover`. This one reacts on hover. -{% capture code %} +```html example centered -{% endcapture %} -{% include example.html code=code %} +``` + +```html + +``` diff --git a/docs/components/progress.mdx b/docs/components/progress.mdx new file mode 100644 index 000000000..094ab86a4 --- /dev/null +++ b/docs/components/progress.mdx @@ -0,0 +1,92 @@ +--- +title: Progress bars +description: Progress bars are used to provide feedback on an action status and inform users of the current progress. Although seemingly small interface elements, they are extremely hepful in managing users' expectations and preventing them from abandoning a process they have initiated. +bootstrapLink: components/progress +--- + +## Default markup + +To create a default progress bar, add a `.progress` class to a `
` element. Thanks to that, you will be able to notify users how long they have to wait for a process to complete. + +```html example columns={1} centered +
+
+
+``` + +```html +
+
+ 38% Complete +
+
+``` + +## Progress size + +Using Bootstrap’s typical naming structure, you can create a standard progress bar or scale it up or down to different sizes based on what’s needed. + +```html code example columns={1} centered +
+
+ 57% Complete +
+
+``` + +## Progress without value + +Remove the displayed value by adding the `.visually-hidden` class. + +```html code example columns={1} centered +
+
+ 75% Complete +
+
+``` + +## Indeterminate progress + +You can create a progress bar which shows indeterminate progress by adding `.progress-bar-indeterminate` to the `.progress-bar` element. + +```html code example columns={1} centered +
+
+
+``` + +## Native progress element + +You can also use native HTML5 `` element. + +```html code example columns={1} centered + +``` + +## Progress color + +Customize the color of the progress bar to suit your design. Click [here](colors) to see the list of available colors. + +```html code example columns={1} centered separated +
+
+ 24% Complete +
+
+
+
+ 45% Complete +
+
+
+
+ 64% Complete +
+
+
+
+ 38% Complete +
+
+``` diff --git a/docs/components/progressbg.mdx b/docs/components/progressbg.mdx new file mode 100644 index 000000000..d06407817 --- /dev/null +++ b/docs/components/progressbg.mdx @@ -0,0 +1,16 @@ +--- +title: Progress background +description: By using a progress bar component as a background element, designers can create a dynamic and engaging visual experience for users. For example, the progress bar could be used to represent the completion of a long-term goal or project, such as a fundraising campaign or construction project. As users interact with the page, the progress bar could gradually fill up, creating a sense of momentum and progress. +--- + +```html code example vertical centered columns={1} +
+
+
+ 35% Complete +
+
+
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Ea eos ullam ut. Doloribus est in laborum, ratione recusandae reprehenderit tenetur. Accusantium consectetur ea enim facere ipsam praesentium quas soluta tenetur?
+
35%
+
+``` diff --git a/docs/components/range-slider.mdx b/docs/components/range-slider.mdx new file mode 100644 index 000000000..15323ee5e --- /dev/null +++ b/docs/components/range-slider.mdx @@ -0,0 +1,17 @@ +--- +title: Range slider +libs: nouislider +--- + +To be able to use the range slider in your application you will need to install the nouislider dependency with `npm install nouislider`. + +All options and features can be found [**here**](https://refreshless.com/nouislider/). + +## Basic range slider + +```html code example +
+

+``` + +That's only the basic features and options of range slider. More possibilities can be found [**here**](https://refreshless.com/nouislider/). diff --git a/docs/components/ribbons.mdx b/docs/components/ribbons.mdx new file mode 100644 index 000000000..8e0331a63 --- /dev/null +++ b/docs/components/ribbons.mdx @@ -0,0 +1,151 @@ +--- +title: Ribbons +description: Ribbons are graphical elements which attract users' attention to a given element of an interface and make it stand out. +--- + +## Default markup + +Use the `ribbon` class to add the default ribbon to any section of your interface. + +```html example columns={1} centered +
+
+
+
+ + + + +
+
+``` + +```html +
+
+
+
+ + ... +
+
+``` + +## Ribbon position + +You can change the position of a ribbon by adding one of the following classes to the element: + +- `ribbon-top` - moves it to the top +- `ribbon-end` - moves it to the right +- `ribbon-bottom` - moves it to the bottom +- `ribbon-start` - moves it to the left + +Using multiple classes at once will give you more position options. For example, the following class: `.ribbon.ribbon-top.ribbon-left` will move the ribbon to the top left corner. + +```html example columns={1} centered +
+
+
+
+ + + + +
+
+``` + +```html +
+
+
+
+ + ... +
+
+``` + +## Ribbon color + +Customize the ribbon's background color. You can click [here](colors) to see the list of available colors. + +```html example columns={1} centered +
+
+
+
+ + + + +
+
+``` + +```html +
+
+
+
+ + ... +
+
+``` + +## Ribbon text + +Add your own text to a ribbon to display any additional information and make it easy to spot for users. + +```html example columns={1} centered +
+
+
+
+ + + + +
+
+``` + +```html +
+
+
+
+ + ... +
+
+``` + +## Ribbon style + +Change the style of a ribbon to make it go well with your interface design. + +```html example columns={1} centered +
+
+
+
+ + + + +
+
+``` + +```html +
+
+
+
+ + ... +
+
+``` diff --git a/docs/components/spinners.mdx b/docs/components/spinners.mdx new file mode 100644 index 000000000..a17555668 --- /dev/null +++ b/docs/components/spinners.mdx @@ -0,0 +1,119 @@ +--- +title: Spinners +description: Spinners are used to show the loading state of a component or page. They provide feedback for an action a user has taken, when it takes a bit longer to complete. +bootstrapLink: components/spinners/ +--- + +## Default markup + +Use the default spinner to notify users that an action they have taken is in progress, helping them avoid confusion. + +```html example code centered +
+``` + +## Colors + +Choose one of the available colors to customize the spinner and make it suit your design. + +```html example centered separated +
+
+
+
+
+
+
+
+
+
+
+
+``` + +```html +
+
+``` + +## Size + +Choose the size of your spinner. You can use the default size or use the `spinner-border-sm` class to display a smaller spinner. + +```html example code centered separated +
+
+``` + +## Growing spinner + +Use the growing spinner, if you are looking for a more original design than a border spinner. The spinner grows to show the loading state. + +```html example code centered +
+``` + +Growing spinners also come in a variety of colors to choose from. + +```html example centered separated +
+
+
+
+
+
+
+
+
+
+
+
+``` + +```html +
+
+``` + +### Button with spinner + +Use buttons with spinners to notify users that an action they have taken by clicking the button is in progress and prevent them from clicking multiple times or giving up. + +```html example centered separated code + + + Button + + + + Button + + + + Button + + + + Button + + + + Button + +``` + +## Animated dots + +```html example centered code +

Loading

+``` + +```html example centered code separated + + Loading + + + Loading + +``` + diff --git a/docs/components/statuses.mdx b/docs/components/statuses.mdx new file mode 100644 index 000000000..138a43bee --- /dev/null +++ b/docs/components/statuses.mdx @@ -0,0 +1,284 @@ +--- +title: Statuses +description: Status dots are particularly useful if you want to make an interface element more noticeable regardless of limited space. +--- + +## Default markup + +```html example +Blue +Azure +Indigo +Purple +Pink +Red +Orange +Yellow +Lime +Green +Teal +Cyan +``` + +```html +Blue +Azure +``` + +## Status with dot + +```html code example + + + Blue + + + + Azure + + + + Indigo + + + + Purple + + + + Pink + + + + Red + + + + Orange + + + + Yellow + + + + Lime + + + + Green + + + + Teal + + + + Cyan + +``` + +### Animated dot + +```html code example + + + Blue + + + + Azure + + + + Indigo + + + + Purple + + + + Pink + + + + Red + + + + Orange + + + + Yellow + + + + Lime + + + + Green + + + + Teal + + + + Cyan + +``` + +## Lite status + +```html code example + + + Blue + + + + Azure + + + + Indigo + + + + Purple + + + + Pink + + + + Red + + + + Orange + + + + Yellow + + + + Lime + + + + Green + + + + Teal + + + + Cyan + +``` + +## Status dots + +```html code example + + + + + + + + + + + + +``` + +### Animated dots + +```html code example + + + + + + + + + + + + +``` + +## Status indicator + +```html code example + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` diff --git a/docs/components/steps.mdx b/docs/components/steps.mdx new file mode 100644 index 000000000..0d415906e --- /dev/null +++ b/docs/components/steps.mdx @@ -0,0 +1,111 @@ +--- +title: Steps +description: Steps are used to guide users through complex processes, making them easier and more intuitive. Breaking a multi-step process into smaller parts and tracking progress along the way helps users complete it successfully. +new: true +--- + +## Default markup + +Steps show users where they are within a process, what steps they have already completed and what they are expected to complete. Making multi-step processes more user-friendly facilitates users' interaction with your interface. + +Use the `steps` class to create the default progress tracker and name the steps accordingly. + +```html code example + +``` + +## Tooltips + +Add tooltips, if you want to provide users with additional information about the steps they are expected to complete. Tooltips are displayed when a user hovers over a given step and help clarify what might not be clear from the interface. + +```html code example + +``` + +## Color + +You can customize the default progress indicator by changing the color to one that better suits your design. Click [here](colors) to see the range of available colors. + +```html code example + + +``` + +## Steps without title + +For designs with limited space, use progress indicators without titles and add tooltips to provide the necessary details. + +```html code example +
+ + + + +
+``` + +## Steps with numbers + +Use the `steps-counter` class to create a progress tracker with numbers instead of titles and change the color to customize it. + +```html code example +
+ + + + + +
+``` diff --git a/docs/components/switch-icon.mdx b/docs/components/switch-icon.mdx new file mode 100644 index 000000000..8ff9974ed --- /dev/null +++ b/docs/components/switch-icon.mdx @@ -0,0 +1,155 @@ +--- +title: Switch icon +description: The Switch Icon component is used to create a transition between two icons. You can use any icon, both line and filled version. +banner: icons +--- + +## Default markup + +To replace the icons, all should add `active` class to the `switch-icon` component. + +```html code example centered + +``` + +## Switch animations + +You can also add a fancy animation to add variety to your button. See demo below: + +```html example code centered separated + + + + + + + + +``` diff --git a/docs/components/tables.mdx b/docs/components/tables.mdx new file mode 100644 index 000000000..61ed2d15c --- /dev/null +++ b/docs/components/tables.mdx @@ -0,0 +1,410 @@ +--- +title: Tables +description: Tables are a useful interface element that allows to visualise data and arrange it in a clear way. Thanks to that, users can browse a lot of information at once and a good table design will help you take care of its clarity. +bootstrapLink: content/tables/ +--- + +## Basic Table + +The basic table design has light padding and the presented data is separated wih horizontal dividers. It helps provide users with all the necessary information, without overwheling them with visuals. + +The `.table` class adds basic styling to a table: + +```html code example +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTitleEmailRole
Paweł Kuna + UI Designer, Training + paweluna@howstuffworks.com + User + + Edit +
Jeffie Lewzey + Chemical Engineer, Support + jlewzey1@seesaa.net + Admin + + Edit +
Mallory Hulme + Geologist IV, Support + mhulme2@domainmarket.com + User + + Edit +
Dunn Slane + Research Nurse, Sales + dslane3@epa.gov + Owner + + Edit +
Emmy Levet + VP Product Management, Accounting + elevet4@senate.gov + Admin + + Edit +
+
+``` + +## Responsive tables + +Use the `.table-responsive` class across each breakpoint for horizontal scrolling tables. If you want to create responsive tables up to a specific breakpoint, use `.table-responsive{-sm|-md|-lg|-xl}`. From that breakpoint and up, the table will behave normally, rather than scroll horizontally. + +```html code example + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#Heading 1Heading 2Heading 3Heading 4Heading 5Heading 6Heading 7Heading 8Heading 9Heading 10
1CellCellCellCellCellCellCellCellCellCell
2CellCellCellCellCellCellCellCellCellCell
+``` + +## No wrap + +If you don't want the table cell content to wrap to another line, use the `table-nowrap` class. + +```html example +
+ + + + + + + + + + + + + + + + + + + + + +
NameTitleEmailRole
Paweł KunaUI Designer, Training + paweluna@howstuffworks.com + UserLorem ipsum dolor sit amet, consectetur adipisicing elit. Animi, commodi cupiditate debitis deserunt + expedita hic incidunt iste modi molestiae nesciunt non nostrum perferendis perspiciatis placeat praesentium + quaerat quo repellendus, voluptates. + Edit +
+
+``` + +```html +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTitleEmailRole
Paweł Kuna + UI Designer, Training + paweluna@howstuffworks.com + User + Lorem ipsum dolor sit amet, consectetur adipisicing elit. Animi, commodi cupiditate debitis deserunt + expedita hic incidunt iste modi molestiae nesciunt non nostrum perferendis perspiciatis placeat praesentium + quaerat quo repellendus, voluptates. + + Edit +
Jeffie Lewzey + Chemical Engineer, Support + jlewzey1@seesaa.net + Admin + Lorem ipsum dolor sit amet, consectetur adipisicing elit. Animi, commodi cupiditate debitis deserunt + expedita hic incidunt iste modi molestiae nesciunt non nostrum perferendis perspiciatis placeat praesentium + quaerat quo repellendus, voluptates. + + Edit +
Mallory Hulme + Geologist IV, Support + mhulme2@domainmarket.com + User + Lorem ipsum dolor sit amet, consectetur adipisicing elit. Animi, commodi cupiditate debitis deserunt + expedita hic incidunt iste modi molestiae nesciunt non nostrum perferendis perspiciatis placeat praesentium + quaerat quo repellendus, voluptates. + + Edit +
Dunn Slane + Research Nurse, Sales + dslane3@epa.gov + Owner + Lorem ipsum dolor sit amet, consectetur adipisicing elit. Animi, commodi cupiditate debitis deserunt + expedita hic incidunt iste modi molestiae nesciunt non nostrum perferendis perspiciatis placeat praesentium + quaerat quo repellendus, voluptates. + + Edit +
Emmy Levet + VP Product Management, Accounting + elevet4@senate.gov + Admin + Lorem ipsum dolor sit amet, consectetur adipisicing elit. Animi, commodi cupiditate debitis deserunt + expedita hic incidunt iste modi molestiae nesciunt non nostrum perferendis perspiciatis placeat praesentium + quaerat quo repellendus, voluptates. + + Edit +
+
+``` + +## Table Variants + +```html code example + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ClassHeadingHeading
DefaultCellCell
PrimaryCellCell
SecondaryCellCell
SuccessCellCell
DangerCellCell
WarningCellCell
InfoCellCell
LightCellCell
DarkCellCell
+``` + +## Table with sticky header + +```html example code scrollable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ClassHeadingHeading
DefaultCellCell
PrimaryCellCell
SecondaryCellCell
SuccessCellCell
DangerCellCell
WarningCellCell
InfoCellCell
LightCellCell
DarkCellCell
+``` diff --git a/docs/components/tabs.mdx b/docs/components/tabs.mdx new file mode 100644 index 000000000..d35cbba50 --- /dev/null +++ b/docs/components/tabs.mdx @@ -0,0 +1,243 @@ +--- +title: Tabs +description: Tabs allow users to alternate between equally important views within the same context. By dividing content into meaningful sections, they improve its organization and make it easy for users to navigate. +bootstrapLink: components/navs/ +--- + +## Default markup + +Use tabs to let users access different sections within one context quickly and with ease. In the default design, the current tab is highlighted, which makes the interface clear and user-friendly. + +```html code example centered columns={1} height="20rem" +
+
+ +
+
+
+
+

Home tab

+
Cursus turpis vestibulum, dui in pharetra vulputate id sed non turpis ultricies fringilla at sed facilisis lacus pellentesque purus nibh
+
+
+

Profile tab

+
Fringilla egestas nunc quis tellus diam rhoncus ultricies tristique enim at diam, sem nunc amet, pellentesque id egestas velit sed
+
+
+
+
+``` + +## Tabs with icons + +Add icons to your tab labels, if you want to use a visual element and make the tab content easier to identify. + +```html example code centered columns={1} height="20rem" +
+ +
+
+
+

Home tab

+
Cursus turpis vestibulum, dui in pharetra vulputate id sed non turpis ultricies fringilla at sed facilisis lacus pellentesque purus nibh
+
+
+

Profile tab

+
Fringilla egestas nunc quis tellus diam rhoncus ultricies tristique enim at diam, sem nunc amet, pellentesque id egestas velit sed
+
+
+

Settings tab

+
Donec ac vitae diam amet vel leo egestas consequat rhoncus in luctus amet, facilisi sit mauris accumsan nibh habitant senectus
+
+
+
+
+``` + +## Tabs only with icons + +Use tabs without label names to save space and make the tab content easy to recognize for international users. + +```html code example centered columns={1} height="20rem" +
+ +
+
+
+

Home tab

+
Cursus turpis vestibulum, dui in pharetra vulputate id sed non turpis ultricies fringilla at sed facilisis lacus pellentesque purus nibh
+
+
+

Profile tab

+
Fringilla egestas nunc quis tellus diam rhoncus ultricies tristique enim at diam, sem nunc amet, pellentesque id egestas velit sed
+
+
+

Settings tab

+
Donec ac vitae diam amet vel leo egestas consequat rhoncus in luctus amet, facilisi sit mauris accumsan nibh habitant senectus
+
+
+
+
+``` + +## Tabs with dropdown + +Make one or more of your tabs into a dropdown to add more options within one element. + +```html code example centered columns={1} height="20rem" +
+
+ +
+
+
+
+

Home tab

+
Cursus turpis vestibulum, dui in pharetra vulputate id sed non turpis ultricies fringilla at sed facilisis lacus pellentesque purus nibh
+
+
+

Profile tab

+
Fringilla egestas nunc quis tellus diam rhoncus ultricies tristique enim at diam, sem nunc amet, pellentesque id egestas velit sed
+
+
+
+
+``` + +## Full-width tabs + +Add the `nav-fill` class to make the tabs take up the full space of the parent element. + +```html code example centered columns={1} height="20rem" +
+ +
+
+
+

Home tab

+
Cursus turpis vestibulum, dui in pharetra vulputate id sed non turpis ultricies fringilla at sed facilisis lacus pellentesque purus nibh
+
+
+

Profile tab

+
Fringilla egestas nunc quis tellus diam rhoncus ultricies tristique enim at diam, sem nunc amet, pellentesque id egestas velit sed
+
+
+

Activity tab

+
Donec ac vitae diam amet vel leo egestas consequat rhoncus in luctus amet, facilisi sit mauris accumsan nibh habitant senectus
+
+
+
+
+``` diff --git a/docs/components/timelines.mdx b/docs/components/timelines.mdx new file mode 100644 index 000000000..aad6eecba --- /dev/null +++ b/docs/components/timelines.mdx @@ -0,0 +1,506 @@ +--- +title: Timelines +description: A timeline is a perfect way to visualize processes and projects, as it's easy to read and attractive for users. You can use it to give an overview of events, present an agenda or point out important points in time. +--- + +## Timeline + +The available timeline design is comprised of many components that will help you visualize a process or show an outline of events. Thanks to the possibility of adding icons, avatars and links and the way of presenting the elements of content, your timeline will be clear for users and will make yor website or app more attractive. + +```html example +
    +
  • +
    + + + + +
    +
    +
    +
    10 hrs ago
    +

    +1150 Followers

    +

    You’re getting more and more followers, keep it up!

    +
    +
    +
  • +
  • +
    + + + + + + + +
    +
    +
    +
    2 hrs ago
    +

    +3 New Products were added!

    +

    Congratulations!

    +
    +
    +
  • +
  • +
    + + + + +
    +
    +
    +
    1 day ago
    +

    Database backup completed!

    +

    Download the latest backup.

    +
    +
    +
  • +
  • +
    + + + + +
    +
    +
    +
    1 day ago
    +

    +290 Page Likes

    +

    This is great, keep it up!

    +
    +
    +
  • +
  • +
    + + + + + + +
    +
    +
    +
    2 days ago
    +

    +3 Friend Requests

    +
    + + JL + +
    +
    +
    +
  • +
  • +
    + + + + + + + +
    +
    +
    +
    3 days ago
    +

    +2 New photos

    +
    +
    +
    +
    + +
    +
    +
    +
    + +
    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + + +
    +
    +
    +
    2 weeks ago
    +

    System updated to v2.02

    +

    Check the complete changelog at the activity + page.

    +
    +
    +
  • +
+``` + +```html +
    +
  • +
    + ... +
    +
    +
    +
    10 hrs ago
    +

    +1150 Followers

    +

    You’re getting more and more followers, keep it up!

    +
    +
    +
  • +
  • +
    + ... +
    +
    +
    +
    2 hrs ago
    +

    +3 New Products were added!

    +

    Congratulations!

    +
    +
    +
  • +
  • +
    + ... +
    +
    +
    +
    1 day ago
    +

    Database backup completed!

    +

    Download the latest backup.

    +
    +
    +
  • +
  • +
    + ... +
    +
    +
    +
    1 day ago
    +

    +290 Page Likes

    +

    This is great, keep it up!

    +
    +
    +
  • +
  • +
    + ... +
    +
    +
    +
    2 days ago
    +

    +3 Friend Requests

    +
    + + + + JL + + +
    +
    +
    +
  • +
  • +
    + ... +
    +
    +
    +
    3 days ago
    +

    +2 New photos

    +
    +
    +
    +
    + +
    +
    +
    +
    + +
    +
    +
    +
    +
    +
    +
  • +
  • +
    + ... +
    +
    +
    +
    2 weeks ago
    +

    System updated to v2.02

    +

    Check the complete changelog at the activity + page.

    +
    +
    +
  • +
+``` + +## Simple timeline + +Use a simplified version of the timeline, if it suits your design better. You can still make use of all the available timeline components. + +```html example +
    +
  • +
    + + + + +
    +
    +
    +
    10 hrs ago
    +

    +1150 Followers

    +

    You’re getting more and more followers, keep it up!

    +
    +
    +
  • +
  • +
    + + + + + + + +
    +
    +
    +
    2 hrs ago
    +

    +3 New Products were added!

    +

    Congratulations!

    +
    +
    +
  • +
  • +
    + + + + +
    +
    +
    +
    1 day ago
    +

    Database backup completed!

    +

    Download the latest backup.

    +
    +
    +
  • +
  • +
    + + + + +
    +
    +
    +
    1 day ago
    +

    +290 Page Likes

    +

    This is great, keep it up!

    +
    +
    +
  • +
  • +
    + + + + + + +
    +
    +
    +
    2 days ago
    +

    +3 Friend Requests

    +
    + + JL + +
    +
    +
    +
  • +
  • +
    + + + + + + + +
    +
    +
    +
    3 days ago
    +

    +2 New photos

    +
    +
    +
    +
    + +
    +
    +
    +
    + +
    +
    +
    +
    +
    +
    +
  • +
  • +
    + + + + + +
    +
    +
    +
    2 weeks ago
    +

    System updated to v2.02

    +

    Check the complete changelog at the activity + page.

    +
    +
    +
  • +
+``` + +```html +
    +
  • +
    + ... +
    +
    +
    +
    10 hrs ago
    +

    +1150 Followers

    +

    You’re getting more and more followers, keep it up!

    +
    +
    +
  • +
  • +
    + ... +
    +
    +
    +
    2 hrs ago
    +

    +3 New Products were added!

    +

    Congratulations!

    +
    +
    +
  • +
  • +
    + ... +
    +
    +
    +
    1 day ago
    +

    Database backup completed!

    +

    Download the latest backup.

    +
    +
    +
  • +
  • +
    + ... +
    +
    +
    +
    1 day ago
    +

    +290 Page Likes

    +

    This is great, keep it up!

    +
    +
    +
  • +
  • +
    + ... +
    +
    +
    +
    2 days ago
    +

    +3 Friend Requests

    +
    + + + + JL + + +
    +
    +
    +
  • +
  • +
    + ... +
    +
    +
    +
    3 days ago
    +

    +2 New photos

    +
    +
    +
    +
    + +
    +
    +
    +
    + +
    +
    +
    +
    +
    +
    +
  • +
  • +
    + ... +
    +
    +
    +
    2 weeks ago
    +

    System updated to v2.02

    +

    Check the complete changelog at the activity + page.

    +
    +
    +
  • +
+``` diff --git a/docs/components/tinymce.mdx b/docs/components/tinymce.mdx new file mode 100644 index 000000000..3ad0404f0 --- /dev/null +++ b/docs/components/tinymce.mdx @@ -0,0 +1,44 @@ +--- +title: TinyMCE +libs: tinymce +description: The WYSIWYG editor that is flexible, customizable, and designed with the user in mind. TinyMCE can handle any challenge, from the most simple implementation through to the most complex use case. +--- + +[TinyMCE](https://www.tiny.cloud/docs/) documentation. + +## Default text editor + +Initialize TinyMCE 6 on any element (or elements) on the web page by passing an object containing a selector value to `tinymce.init()`. The selector value can be any valid CSS selector. + +```html example code centered columns={2} height="25rem" +
+ +
+ + + +``` diff --git a/docs/components/toasts.mdx b/docs/components/toasts.mdx new file mode 100644 index 000000000..d8aa2b550 --- /dev/null +++ b/docs/components/toasts.mdx @@ -0,0 +1,73 @@ +--- +title: Toasts +description: Toasts are lightweight alert boxes which display for a few seconds after a user has taken an action, to inform them of the state or outcome. They can be used when a user clicks a button or submits a form and their aim is to provide feedback, rather than encourage to take action. +bootstrapLink: components/toasts/ +--- + +## Default markup + +Use the default toast message to inform users of the outcome of their action and provide additional information. It contains an `x` close button to make it possible for users to close the toast if they wish. + +```html example code + +``` + +## Translucent + +Toasts blend over the elements they appear over. If a browser supports the `backdrop-filter` CSS property, the elements under a toast will be blurred. + +```html example code + +``` + +## Stacking toasts + +Stack multiple toasts together by putting them within one `.toast-container`. + +```html example code +
+ + +
+``` + diff --git a/src/pages/_docs/tooltips.md b/docs/components/tooltips.mdx similarity index 85% rename from src/pages/_docs/tooltips.md rename to docs/components/tooltips.mdx index 35385e5e1..1a493a0a7 100644 --- a/src/pages/_docs/tooltips.md +++ b/docs/components/tooltips.mdx @@ -1,16 +1,14 @@ --- title: Tooltips -menu: help.docs.components.tooltips description: Tooltips are text labels which appear when a user hovers over an interface element. They explain the interface elements that may be unclear for users and guide them when they need help. If used properly, tooltips can significantly enhance user experience and add value to your website or software. -bootstrap-link: components/tooltips/ +bootstrapLink: components/tooltips/ --- - ## Default markup -Use the default markup to create tooltips that will help users understand particular elements of your interface. You can decide where the text label is to be displayed - at the top, bottom or on either side of the element. +Use the default markup to create tooltips that will help users understand particular elements of your interface. You can decide where the text label is to be displayed - at the top, bottom or on either side of the element. -{% capture code %} +```html code example @@ -23,17 +21,14 @@ Use the default markup to create tooltips that will help users understand partic -{% endcapture %} -{% include example.html code=code %} - +``` ## Tooltip with HTML If the default tooltip is not enough, you can add the option to use HTML code in the text to highlight particular bits of information and make the content more attractive. -{% capture code %} +```html code example -{% endcapture %} -{% include example.html code=code %} +``` diff --git a/docs/components/tracking.mdx b/docs/components/tracking.mdx new file mode 100644 index 000000000..18e66b5d1 --- /dev/null +++ b/docs/components/tracking.mdx @@ -0,0 +1,162 @@ +--- +title: Tracking +description: Component for visualising activity logs or other monitoring-related data. With its ability to show data in a visually appealing and easily understandable way, the tracking component is an essential tool for any organization that relies on data monitoring and analysis to optimize performance and user experience. +--- + +## Basic example + +```html example centered columns={1} +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+``` + +```html +
+ ... +
+
+
+ ... +
+``` + +## Tracking inside a card + +You can add a tracking component inside the cards to give your reports a fresh look and visualise the status of your system in an attractive way. If you want to read how to add other elements to card it is worth reading [documentation of card](/docs/components/cards). + +```html example centered columns={1} +
+
+
+
Status monitoring
+ +
+
+
99.5%
+
+ + 2% + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+``` + +```html +
+
+
+
Status monitoring
+ +
+
+
99.5%
+
+ + 2% + + +
+
+
+
+
+
+
+
+
+
+ ... +
+
+
+
+``` diff --git a/docs/config.json b/docs/config.json new file mode 100644 index 000000000..5adf8fca5 --- /dev/null +++ b/docs/config.json @@ -0,0 +1,1487 @@ +{ + "libs": { + "bootstrap": "bootstrap/dist/js/bootstrap.bundle.min.js", + "apexcharts": "apexcharts/dist/apexcharts.min.js", + "nouislider": "nouislider/dist/nouislider.min.js", + "countup": "countup.js/dist/countUp.js", + "lists": "list.js/dist/list.min.js", + "masonry": "https://cdnjs.cloudflare.com/ajax/libs/masonry/4.2.2/masonry.pkgd.min.js", + "mapbox": "https://api.mapbox.com/mapbox-gl-js/v1.8.0/mapbox-gl.js", + "google-maps": "https://maps.googleapis.com/maps/api/js?key=GOOGLE_MAPS_KEY", + "litepicker": "litepicker/dist/litepicker.js", + "tom-select": "tom-select/dist/js/tom-select.base.min.js", + "jsvectormap": "jsvectormap/dist/js/jsvectormap.min.js", + "jsvectormap-world": "jsvectormap/dist/maps/world.js", + "jsvectormap-world-merc": "jsvectormap/dist/maps/world-merc.js", + "fslightbox": "fslightbox/index.js", + "tinymce": "tinymce/tinymce.min.js", + "plyr": "plyr/dist/plyr.min.js", + "dropzone": "dropzone/dist/dropzone-min.js" + }, + "colors": { + "base": [ + { + "name": "blue", + "variable": "var(--tblr-blue)", + "value": "#206bc4" + }, + { + "name": "azure", + "variable": "var(--tblr-azure)", + "value": "#4299e1" + }, + { + "name": "indigo", + "variable": "var(--tblr-indigo)", + "value": "#4263eb" + }, + { + "name": "purple", + "variable": "var(--tblr-purple)", + "value": "#ae3ec9" + }, + { + "name": "pink", + "variable": "var(--tblr-pink)", + "value": "#d6336c" + }, + { + "name": "red", + "variable": "var(--tblr-red)", + "value": "#d63939" + }, + { + "name": "orange", + "variable": "var(--tblr-orange)", + "value": "#f76707" + }, + { + "name": "yellow", + "variable": "var(--tblr-yellow)", + "value": "#f59f00" + }, + { + "name": "lime", + "variable": "var(--tblr-lime)", + "value": "#74b816" + }, + { + "name": "green", + "variable": "var(--tblr-green)", + "value": "#2fb344" + }, + { + "name": "teal", + "variable": "var(--tblr-teal)", + "value": "#0ca678" + }, + { + "name": "cyan", + "variable": "var(--tblr-cyan)", + "value": "#17a2b8" + } + ], + "grays": [ + { + "name": "gray-50", + "value": "#f8fafc" + }, + { + "name": "gray-100", + "value": "#f1f5f9" + }, + { + "name": "gray-200", + "value": "#e2e8f0" + }, + { + "name": "gray-300", + "value": "#c8d3e1" + }, + { + "name": "gray-400", + "value": "#9ba9be" + }, + { + "name": "gray-500", + "value": "#6c7a91" + }, + { + "name": "gray-600", + "value": "#49566c" + }, + { + "name": "gray-700", + "value": "#313c52" + }, + { + "name": "gray-800", + "value": "#1d273b" + }, + { + "name": "gray-900", + "value": "#0f172a" + } + ], + "light": [ + { + "name": "blue-lt", + "value": "#e9f0f9" + }, + { + "name": "azure-lt", + "value": "#ecf5fc" + }, + { + "name": "indigo-lt", + "value": "#eceffd" + }, + { + "name": "purple-lt", + "value": "#f7ecfa" + }, + { + "name": "pink-lt", + "value": "#fbebf0" + }, + { + "name": "red-lt", + "value": "#fbebeb" + }, + { + "name": "orange-lt", + "value": "#fef0e6" + }, + { + "name": "yellow-lt", + "value": "#fef5e6" + }, + { + "name": "lime-lt", + "value": "#f1f8e8" + }, + { + "name": "green-lt", + "value": "#eaf7ec" + }, + { + "name": "teal-lt", + "value": "#e7f6f2" + }, + { + "name": "cyan-lt", + "value": "#e8f6f8" + } + ], + "social": [ + { + "name": "facebook", + "value": "#1877F2" + }, + { + "name": "twitter", + "value": "#1da1f2" + }, + { + "name": "linkedin", + "value": "#0a66c2" + }, + { + "name": "google", + "value": "#dc4e41" + }, + { + "name": "youtube", + "value": "#ff0000" + }, + { + "name": "vimeo", + "value": "#1ab7ea" + }, + { + "name": "dribbble", + "value": "#ea4c89" + }, + { + "name": "github", + "value": "#181717" + }, + { + "name": "instagram", + "value": "#e4405f" + }, + { + "name": "pinterest", + "value": "#bd081c" + }, + { + "name": "vk", + "value": "#6383a8" + }, + { + "name": "rss", + "value": "#ffa500" + }, + { + "name": "flickr", + "value": "#0063dc" + }, + { + "name": "bitbucket", + "value": "#0052cc" + }, + { + "name": "tabler", + "value": "#206bc4" + } + ] + }, + "flags": [ + { + "name": "Andorra", + "flag": "ad" + }, + { + "name": "United Arab Emirates", + "flag": "ae" + }, + { + "name": "Afghanistan", + "flag": "af" + }, + { + "name": "Antigua", + "flag": "ag" + }, + { + "name": "Anguilla", + "flag": "ai" + }, + { + "name": "Armenia", + "flag": "am" + }, + { + "name": "Angolan", + "flag": "ao" + }, + { + "name": "Antarctica", + "flag": "aq" + }, + { + "name": "Argentina", + "flag": "ar" + }, + { + "name": "American Samoa", + "flag": "as" + }, + { + "name": "Austria", + "flag": "at" + }, + { + "name": "Australia", + "flag": "au" + }, + { + "name": "Aruba", + "flag": "aw" + }, + { + "name": "Aslan Islands", + "flag": "ax" + }, + { + "name": "Azerbaijan", + "flag": "az" + }, + { + "name": "Bosnian", + "flag": "ba" + }, + { + "name": "Barbados", + "flag": "bb" + }, + { + "name": "Belgium", + "flag": "be" + }, + { + "name": "Burkina Faso", + "flag": "bf" + }, + { + "name": "Bulgaria", + "flag": "bg" + }, + { + "name": "Bahrain", + "flag": "bh" + }, + { + "name": "Burundi", + "flag": "bi" + }, + { + "name": "Benin", + "flag": "bj" + }, + { + "name": "Saint-Barthélemy", + "flag": "bl" + }, + { + "name": "Bermuda", + "flag": "bm" + }, + { + "name": "Bruneian", + "flag": "bn" + }, + { + "name": "Bolivia", + "flag": "bo" + }, + { + "name": "Bonaire", + "flag": "bq" + }, + { + "name": "Brazil", + "flag": "br" + }, + { + "name": "Bahamas", + "flag": "bs" + }, + { + "name": "Bhutan", + "flag": "bt" + }, + { + "name": "Bouvet Island", + "flag": "bv" + }, + { + "name": "Batswana", + "flag": "bw" + }, + { + "name": "Belarus", + "flag": "by" + }, + { + "name": "Belize", + "flag": "bz" + }, + { + "name": "Canada", + "flag": "ca" + }, + { + "name": "Cocos Island", + "flag": "cc" + }, + { + "name": "Democratic Republic of Congo", + "flag": "cd" + }, + { + "name": "Central African Republic", + "flag": "cf" + }, + { + "name": "Republic of the Congo", + "flag": "cg" + }, + { + "name": "Switzerland", + "flag": "ch" + }, + { + "name": "Ivory Coast", + "flag": "ci" + }, + { + "name": "Cook Island", + "flag": "ck" + }, + { + "name": "Chile", + "flag": "cl" + }, + { + "name": "Cameroon", + "flag": "cm" + }, + { + "name": "China", + "flag": "cn" + }, + { + "name": "Colombia", + "flag": "co" + }, + { + "name": "Costa Rica", + "flag": "cr" + }, + { + "name": "Cuba", + "flag": "cu" + }, + { + "name": "Cape Verde", + "flag": "cv" + }, + { + "name": "Curacao", + "flag": "cw" + }, + { + "name": "Christmas Island", + "flag": "cx" + }, + { + "name": "Cyprus", + "flag": "cy" + }, + { + "name": "Czech Republic", + "flag": "cz" + }, + { + "name": "Germany", + "flag": "de" + }, + { + "name": "Djibouti", + "flag": "dj" + }, + { + "name": "Denmark", + "flag": "dk" + }, + { + "name": "Dominica", + "flag": "dm" + }, + { + "name": "Dominican Republic", + "flag": "do" + }, + { + "name": "Algeria", + "flag": "dz" + }, + { + "name": "Ecuador", + "flag": "ec" + }, + { + "name": "Estonia", + "flag": "ee" + }, + { + "name": "Egypt", + "flag": "eg" + }, + { + "name": "Sahrawi", + "flag": "eh" + }, + { + "name": "Eritrea", + "flag": "er" + }, + { + "name": "Spain", + "flag": "es" + }, + { + "name": "Catalonia", + "flag": "es-ct" + }, + { + "name": "Ethiopia", + "flag": "et" + }, + { + "name": "European Union", + "flag": "eu" + }, + { + "name": "Finland", + "flag": "fi" + }, + { + "name": "Fiji", + "flag": "fj" + }, + { + "name": "Falkland Islands", + "flag": "fk" + }, + { + "name": "Federate States of Micronesia", + "flag": "fm" + }, + { + "name": "Faroe Islands", + "flag": "fo" + }, + { + "name": "France", + "flag": "fr" + }, + { + "name": "Gabon", + "flag": "ga" + }, + { + "name": "Great Britain", + "flag": "gb" + }, + { + "name": "England", + "flag": "gb-eng" + }, + { + "name": "Nothern Ireland", + "flag": "gb-nir" + }, + { + "name": "Scotland", + "flag": "gb-sct" + }, + { + "name": "Wales", + "flag": "gb-wls" + }, + { + "name": "Grenada", + "flag": "gd" + }, + { + "name": "Georgia", + "flag": "ge" + }, + { + "name": "Guyana", + "flag": "gf" + }, + { + "name": "Guernsey", + "flag": "gg" + }, + { + "name": "Ghana", + "flag": "gh" + }, + { + "name": "Gibraltar", + "flag": "gi" + }, + { + "name": "Greenland", + "flag": "gl" + }, + { + "name": "Gambia", + "flag": "gm" + }, + { + "name": "Guinea", + "flag": "gn" + }, + { + "name": "Guadeloupe", + "flag": "gp" + }, + { + "name": "Equatorial Guinea", + "flag": "gq" + }, + { + "name": "Greece", + "flag": "gr" + }, + { + "name": "South Georgia", + "flag": "gs" + }, + { + "name": "Guatemala", + "flag": "gt" + }, + { + "name": "Guam", + "flag": "gu" + }, + { + "name": "Guinea-Bissau", + "flag": "gw" + }, + { + "name": "Guyana", + "flag": "gy" + }, + { + "name": "Hong Kong", + "flag": "hk" + }, + { + "name": "Heard and McDonald Islands", + "flag": "hm" + }, + { + "name": "Honduras", + "flag": "hn" + }, + { + "name": "Croatia", + "flag": "hr" + }, + { + "name": "Haiti", + "flag": "ht" + }, + { + "name": "Hungary", + "flag": "hu" + }, + { + "name": "Indonesia", + "flag": "id" + }, + { + "name": "Ireland", + "flag": "ie" + }, + { + "name": "Israel", + "flag": "il" + }, + { + "name": "Isle of Man", + "flag": "im" + }, + { + "name": "India", + "flag": "in" + }, + { + "name": "British Indian Ocean Territory", + "flag": "io" + }, + { + "name": "Iraq", + "flag": "iq" + }, + { + "name": "Iran", + "flag": "ir" + }, + { + "name": "Iceland", + "flag": "is" + }, + { + "name": "Italy", + "flag": "it" + }, + { + "name": "Jersey", + "flag": "je" + }, + { + "name": "Jamaica", + "flag": "jm" + }, + { + "name": "Jordan", + "flag": "jo" + }, + { + "name": "Japan", + "flag": "jp" + }, + { + "name": "Kenya", + "flag": "ke" + }, + { + "name": "Kyrgyzstan", + "flag": "kg" + }, + { + "name": "Cambodia", + "flag": "kh" + }, + { + "name": "Kiribati", + "flag": "ki" + }, + { + "name": "Comoros", + "flag": "km" + }, + { + "name": "Saint Kitts and Nevis", + "flag": "kn" + }, + { + "name": "North Korea", + "flag": "kp" + }, + { + "name": "South Korea", + "flag": "kr" + }, + { + "name": "Kuwait", + "flag": "kw" + }, + { + "name": "Cayman Islands", + "flag": "ky" + }, + { + "name": "Kazakhstan", + "flag": "kz" + }, + { + "name": "Laos", + "flag": "la" + }, + { + "name": "Lebanese", + "flag": "lb" + }, + { + "name": "Saint Lucia", + "flag": "lc" + }, + { + "name": "Liechtenstein", + "flag": "li" + }, + { + "name": "Sri Lanka", + "flag": "lk" + }, + { + "name": "Liberia", + "flag": "lr" + }, + { + "name": "Lesotho", + "flag": "ls" + }, + { + "name": "Lithuania", + "flag": "lt" + }, + { + "name": "Luxembourg", + "flag": "lu" + }, + { + "name": "Latvia", + "flag": "lv" + }, + { + "name": "Libya", + "flag": "ly" + }, + { + "name": "Morocco", + "flag": "ma" + }, + { + "name": "Monaco", + "flag": "mc" + }, + { + "name": "Moldova", + "flag": "md" + }, + { + "name": "Montenegro", + "flag": "me" + }, + { + "name": "Saint Martin", + "flag": "mf" + }, + { + "name": "Madagascar", + "flag": "mg" + }, + { + "name": "Marshall Islands", + "flag": "mh" + }, + { + "name": "Macedonia", + "flag": "mk" + }, + { + "name": "Mali", + "flag": "ml" + }, + { + "name": "Myanmar", + "flag": "mm" + }, + { + "name": "Mongolia", + "flag": "mn" + }, + { + "name": "Macao", + "flag": "mo" + }, + { + "name": "Nothern Mariana Islands", + "flag": "mp" + }, + { + "name": "Martinique", + "flag": "mq" + }, + { + "name": "Mauritania", + "flag": "mr" + }, + { + "name": "Montserrat", + "flag": "ms" + }, + { + "name": "Malta", + "flag": "mt" + }, + { + "name": "Mauritius", + "flag": "mu" + }, + { + "name": "Maldives", + "flag": "mv" + }, + { + "name": "Malawi", + "flag": "mw" + }, + { + "name": "Mexico", + "flag": "mx" + }, + { + "name": "Malaysia", + "flag": "my" + }, + { + "name": "Mozambique", + "flag": "mz" + }, + { + "name": "Namibia", + "flag": "na" + }, + { + "name": "New Caledonia", + "flag": "nc" + }, + { + "name": "Niger", + "flag": "ne" + }, + { + "name": "Norfolk Island", + "flag": "nf" + }, + { + "name": "Nigeria", + "flag": "ng" + }, + { + "name": "Nicaragua", + "flag": "ni" + }, + { + "name": "Norway", + "flag": "no" + }, + { + "name": "Nepal", + "flag": "np" + }, + { + "name": "Nauruan", + "flag": "nr" + }, + { + "name": "Niger", + "flag": "nu" + }, + { + "name": "New Zealand", + "flag": "nz" + }, + { + "name": "Oman", + "flag": "om" + }, + { + "name": "Panama", + "flag": "pa" + }, + { + "name": "Peru", + "flag": "pe" + }, + { + "name": "French Polynesia", + "flag": "pf" + }, + { + "name": "Papua New Guinea", + "flag": "pg" + }, + { + "name": "Philippines", + "flag": "ph" + }, + { + "name": "Pakistan", + "flag": "pk" + }, + { + "name": "Poland", + "flag": "pl" + }, + { + "name": "Saint Pierre", + "flag": "pm" + }, + { + "name": "Pitcairn Islands", + "flag": "pn" + }, + { + "name": "Puerto Rico", + "flag": "pr" + }, + { + "name": "Palestine", + "flag": "ps" + }, + { + "name": "Portugal", + "flag": "pt" + }, + { + "name": "Palau", + "flag": "pw" + }, + { + "name": "Paraguay", + "flag": "py" + }, + { + "name": "Qatar", + "flag": "qa" + }, + { + "name": "Reunion Island", + "flag": "re" + }, + { + "name": "Romania", + "flag": "ro" + }, + { + "name": "Serbia", + "flag": "rs" + }, + { + "name": "Russia", + "flag": "ru" + }, + { + "name": "Rwanda", + "flag": "rw" + }, + { + "name": "Saudi Arabia", + "flag": "sa" + }, + { + "name": "Solomon Islands", + "flag": "sb" + }, + { + "name": "Seychelles", + "flag": "sc" + }, + { + "name": "Sudan", + "flag": "sd" + }, + { + "name": "Sweden", + "flag": "se" + }, + { + "name": "Singapore", + "flag": "sg" + }, + { + "name": "Saint Helena", + "flag": "sh" + }, + { + "name": "Slovenia", + "flag": "si" + }, + { + "name": "Svalbard Island", + "flag": "sj" + }, + { + "name": "Slovakia", + "flag": "sk" + }, + { + "name": "Sierra Leone", + "flag": "sl" + }, + { + "name": "San Marino", + "flag": "sm" + }, + { + "name": "Senegal", + "flag": "sn" + }, + { + "name": "Somalia", + "flag": "so" + }, + { + "name": "Suriname", + "flag": "sr" + }, + { + "name": "South Sudan", + "flag": "ss" + }, + { + "name": "Sao Tome", + "flag": "st" + }, + { + "name": "El Salvador", + "flag": "sv" + }, + { + "name": "Sint Maarten", + "flag": "sx" + }, + { + "name": "Syria", + "flag": "sy" + }, + { + "name": "Swaziland", + "flag": "sz" + }, + { + "name": "Turks and Caicos", + "flag": "tc" + }, + { + "name": "Chad", + "flag": "td" + }, + { + "name": "French Southern and Antarctic Lands", + "flag": "tf" + }, + { + "name": "Togo", + "flag": "tg" + }, + { + "name": "Thailand", + "flag": "th" + }, + { + "name": "Tajikistan", + "flag": "tj" + }, + { + "name": "Tokelau", + "flag": "tk" + }, + { + "name": "Timor Leste", + "flag": "tl" + }, + { + "name": "Turkmenistan", + "flag": "tm" + }, + { + "name": "Tunisia", + "flag": "tn" + }, + { + "name": "Tonga", + "flag": "to" + }, + { + "name": "Turkey", + "flag": "tr" + }, + { + "name": "Trinidad and Tobago", + "flag": "tt" + }, + { + "name": "Tuvalu", + "flag": "tv" + }, + { + "name": "Tanzania", + "flag": "tz" + }, + { + "name": "Ukraine", + "flag": "ua" + }, + { + "name": "Uganda", + "flag": "ug" + }, + { + "name": "United States Minor Islands", + "flag": "um" + }, + { + "name": "United Nations", + "flag": "un" + }, + { + "name": "United States of America", + "flag": "us" + }, + { + "name": "Uruguay", + "flag": "uy" + }, + { + "name": "Uzbekistan", + "flag": "uz" + }, + { + "name": "Vatican City", + "flag": "va" + }, + { + "name": "Saint Vincent", + "flag": "vc" + }, + { + "name": "Venezuela", + "flag": "ve" + }, + { + "name": "British Virgin Islands", + "flag": "vg" + }, + { + "name": "Virgiin Islands", + "flag": "vi" + }, + { + "name": "Vietnam", + "flag": "vn" + }, + { + "name": "Vanuatu", + "flag": "vu" + }, + { + "name": "Wallis and Futuna", + "flag": "wf" + }, + { + "name": "Samoa", + "flag": "ws" + }, + { + "name": "Yemen", + "flag": "ye" + }, + { + "name": "South Africa", + "flag": "za" + }, + { + "name": "Zambia", + "flag": "zm" + }, + { + "name": "Zimbabwe", + "flag": "zw" + } + ], + "payments": [ + { + "name": "2checkout", + "logo": "2checkout" + }, + { + "name": "Alipay", + "logo": "alipay" + }, + { + "name": "Amazon", + "logo": "amazon" + }, + { + "name": "Americanexpress", + "logo": "americanexpress" + }, + { + "name": "Applepay", + "logo": "applepay" + }, + { + "name": "Bancontact", + "logo": "bancontact" + }, + { + "name": "Bitcoin", + "logo": "bitcoin" + }, + { + "name": "Bitpay", + "logo": "bitpay" + }, + { + "name": "Blik", + "logo": "blik" + }, + { + "name": "Cirrus", + "logo": "cirrus" + }, + { + "name": "Clickandbuy", + "logo": "clickandbuy" + }, + { + "name": "Coinkite", + "logo": "coinkite" + }, + { + "name": "Dinersclub", + "logo": "dinersclub" + }, + { + "name": "Directdebit", + "logo": "directdebit" + }, + { + "name": "Discover", + "logo": "discover" + }, + { + "name": "Dotpay", + "logo": "dotpay" + }, + { + "name": "Dwolla", + "logo": "dwolla" + }, + { + "name": "Ebay", + "logo": "ebay" + }, + { + "name": "Epayco", + "logo": "epayco" + }, + { + "name": "Eway", + "logo": "eway" + }, + { + "name": "Giropay", + "logo": "giropay" + }, + { + "name": "Googlewallet", + "logo": "googlewallet" + }, + { + "name": "Ingenico", + "logo": "ingenico" + }, + { + "name": "Jcb", + "logo": "jcb" + }, + { + "name": "Klarna", + "logo": "klarna" + }, + { + "name": "Laser", + "logo": "laser" + }, + { + "name": "Maestro", + "logo": "maestro" + }, + { + "name": "Mastercard", + "logo": "mastercard" + }, + { + "name": "Mir", + "logo": "mir" + }, + { + "name": "Monero", + "logo": "monero" + }, + { + "name": "Neteller", + "logo": "neteller" + }, + { + "name": "Ogone", + "logo": "ogone" + }, + { + "name": "Okpay", + "logo": "okpay" + }, + { + "name": "Paybox", + "logo": "paybox" + }, + { + "name": "Paymill", + "logo": "paymill" + }, + { + "name": "Payone", + "logo": "payone" + }, + { + "name": "Payoneer", + "logo": "payoneer" + }, + { + "name": "Paypal", + "logo": "paypal" + }, + { + "name": "Paysafecard", + "logo": "paysafecard" + }, + { + "name": "Payu", + "logo": "payu" + }, + { + "name": "Payza", + "logo": "payza" + }, + { + "name": "Przelewy24", + "logo": "przelewy24" + }, + { + "name": "Ripple", + "logo": "ripple" + }, + { + "name": "Sage", + "logo": "sage" + }, + { + "name": "Sepa", + "logo": "sepa" + }, + { + "name": "Shopify", + "logo": "shopify" + }, + { + "name": "Skrill", + "logo": "skrill" + }, + { + "name": "Solo", + "logo": "solo" + }, + { + "name": "Square", + "logo": "square" + }, + { + "name": "Stripe", + "logo": "stripe" + }, + { + "name": "Switch", + "logo": "switch" + }, + { + "name": "Tpay", + "logo": "tpay" + }, + { + "name": "Ukash", + "logo": "ukash" + }, + { + "name": "Unionpay", + "logo": "unionpay" + }, + { + "name": "Verifone", + "logo": "verifone" + }, + { + "name": "Verisign", + "logo": "verisign" + }, + { + "name": "Visa", + "logo": "visa" + }, + { + "name": "Webmoney", + "logo": "webmoney" + }, + { + "name": "Westernunion", + "logo": "westernunion" + }, + { + "name": "Worldpay", + "logo": "worldpay" + } + ] +} diff --git a/docs/forms/form-color-check.mdx b/docs/forms/form-color-check.mdx new file mode 100644 index 000000000..2567b7758 --- /dev/null +++ b/docs/forms/form-color-check.mdx @@ -0,0 +1,179 @@ +--- +title: Color check +--- + +Your input controls can come in a variety of colors, depending on your preferences. Click [here](/docs/getting-started/colors) to see the list of available colors. + +```html example centered +
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
+``` + +```html + +``` + +```html example centered +
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
+``` + +```html + +``` + +## Input color picker + +Add an color picker to your form to let users customise it according to their preferences. + +```html example code centered +
+ + +
+``` + diff --git a/docs/forms/form-elements.mdx b/docs/forms/form-elements.mdx new file mode 100644 index 000000000..0b1039e60 --- /dev/null +++ b/docs/forms/form-elements.mdx @@ -0,0 +1,570 @@ +--- +title: Form elements +description: Forms are one of the most important types of interaction with a website or app. Since their aim is to enable users to make a purchase, subscribe to a service or sign up to create an account, it's important to make sure they are easy to complete and help increase conversion rates. Use the available elements to create forms which are well-structured and user-friendly. +bootstrapLink: components/forms/ +libs: nouislider +--- + +## Table of contents + +## Classic inputs + +Use classic, user-friendly inputs, label them appropriately and include input placeholders that will help users avoid confusion when completing a form. + +```html code example +
+ + +
+
+ + +
+``` + +## Form control rounded + +Use the ``form-control-rounded`` class if you prefer form controls with rounded corners. + +```html example +
+ + +
+ + + + + + + + +
+
+``` + +```html +
+ + +
+ + + + ... + +
+
+``` + +## Form control flush + +You can remove borders from your form control by adding the ``form-control-flush`` class. + +```html code example +
+ + +
+``` + +## Input with icon + +Add icons to your input controls to suggest users what they should enter or inform them of the current state of a form element. + +```html example +
+ +
+ + + + + + + + + +
+
+ + + + + + + + + +
+
+
+ +
+ + +
+
+
+
+ +
+
+ +
+
+``` + +```html +
+ +
+ + + + ... + +
+
+ + + ... + + +
+
+
+ +
+ + +
+
+
+
+ +
+
+ +
+
+``` + +## Separated inputs + +Include an additional element in your input section, such as a button which can be used to submit the information enetered in the input control. + +```html example +
+ +
+
+ +
+ +
+
+``` + +```html +
+ +
+
+ +
+ +
+
+``` + +## Textarea and select + +Use a multi-line text input control to enable users to enter longer pieces of text. The control will automatically adjust to the length of the text entered. + +Add one of the available selects - either a dropdown or a multiple choice select - to let users choose from a predefined set of options. + +```html code example +
+ + +
+
+
Select
+ +
+
+
Select multiple
+ +
+``` + +## Input size + +Choose the size of an input control that will go well with your form design. Apart from the default size, you can also use small and large input controls. + +```html code example +
+ + + + +
+``` + +## Datalists + +Use the ``datalist`` element to add an autocomplete feature to your input control. The list of available options will display once a user starts to type and will make it quicker to complete form sections. + +```html exmaple +
+ + + + +
+``` + +## Toggle switches + +Use toggle switches for the elements of your form which require choosing between two opposing states. + +``` +
+
Toggle switches
+ + + +
+
+
Single switch
+ +
+``` + +## Radios + +Use radio buttons for the parts of your form which require users to choose one option from a set of two or more mutually exclusive options. + +``` +
+
Radios
+
+ + + + +
+
+
+
Inline Radios
+
+ + + +
+
+``` + +## Checkboxes + +Use checkoxes if you want to allow users to select more than one option from a set of predefined options or to turn an option on or off. + +``` +
+
Checkboxes
+
+ + + +
+
+
+
Inline Checkboxes
+
+ + + +
+
+``` + +## Range input + +Add a range slider to make it possible for users to set a value or range, such as a price range or a time frame. + +``` +
+ + +
+
+
+
+ +``` + +## Input group + +Create a group of input controls and place add-ons on either side of an input. + +```html code example +
+ +
+ + @ + + +
+
+ + + .tabler.io + +
+
+ + https:// + + + + .tabler.io + +
+
+``` + +## Input with checkboxes or radios + +Add checkboxes or radio buttons on either side of your input control. + +```html code example +
+ +
+ + + + +
+
+ + + + +
+
+``` + +## Input with prepended or appended text + +Add text to your input control, either before or after the text which is to be entered by a user. + +```html code example +
+ +
+ + https://tabler.io/users/ + + +
+
+ + + .tabler.io + +
+
+``` + +## Input with appended link + +Include a link in your input control to add a clickable element within the control. + +```html code example +
+ +
+ + + Show password + +
+
+``` + +## Input with appended `` + +Include a `` in your input control to add shortcut to the control. + +```html code example +
+ +
+ + + ctrl + K + +
+
+``` + +## Input with appended icon links + +Add an icon link which you want to display at the end of your input control to visually represent actions which a user can take. + +```html example +
+ + +
+``` + +```html +
+ + +
+``` diff --git a/docs/forms/form-fieldset.mdx b/docs/forms/form-fieldset.mdx new file mode 100644 index 000000000..1e25faf5f --- /dev/null +++ b/docs/forms/form-fieldset.mdx @@ -0,0 +1,44 @@ +--- +title: Form fieldset +description: By grouping form elements together with the fieldset element, you can improve the organization and accessibility of your forms, making it easier for users to understand the purpose of each input and provide accurate information. +--- + +## Default markup + +Group parts of your form to make it well-structured and clearer for users, using the ``fieldset`` element. + +```html example centered columns="1" height="470" background="white" +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+ +
+``` + +```html +
+ ... +
+ + +
+ ... +
+``` diff --git a/src/pages/_docs/form-helpers.md b/docs/forms/form-helpers.mdx similarity index 82% rename from src/pages/_docs/form-helpers.md rename to docs/forms/form-helpers.mdx index a060a80a2..5cc25f62a 100644 --- a/src/pages/_docs/form-helpers.md +++ b/docs/forms/form-helpers.mdx @@ -1,15 +1,12 @@ --- title: Form helpers -description: A form helper can be used to provide users with additional information about the elements of a form that may be unclear. -menu: help.docs.forms.form-helpers +description: A form helper can be used to provide users with additional information about the elements of a form that may be unclear. --- - ## Input help -Use an input helper to display additional information about a form element. The text label will appear once a user hovers over the helper. +Use an input helper to display additional information about a form element. The text label will appear once a user hovers over the helper. -{% capture code %} +```html example code centered ? -{% endcapture %} -{% include example.html code=code %} +``` diff --git a/docs/forms/form-image-check.mdx b/docs/forms/form-image-check.mdx new file mode 100644 index 000000000..107828241 --- /dev/null +++ b/docs/forms/form-image-check.mdx @@ -0,0 +1,162 @@ +--- +title: Image check +--- + +Add an image check to your form and give users visually attractive options to choose from. + +```html example centered columns="2" height="15rem" +
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
+``` + +```html + +``` + +```html example centered columns="2" height="15rem" +
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
+``` + +```html + +``` + +```html example centered columns="1" height="15rem" +
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
+``` + +```html + +``` diff --git a/src/pages/_docs/input-mask.md b/docs/forms/form-input-mask.mdx similarity index 54% rename from src/pages/_docs/input-mask.md rename to docs/forms/form-input-mask.mdx index 95ffa8c6b..fffce0793 100644 --- a/src/pages/_docs/input-mask.md +++ b/docs/forms/form-input-mask.mdx @@ -1,17 +1,18 @@ --- title: Input mask description: An input mask is a used to clarify the input format required in a given field and is helpful for users, removing confusion and reducing the number of validation errors. -menu: help.docs.plugins.input-mask --- -To be able to use the input mask in your application you will need to install the imask dependency with `npm install imask`. + + To be able to use the input mask in your application you will need to install the imask dependency with `npm install imask`. + ## Default markup Use an input mask in the fields where users have to enter their phone number, to make the formatting rules clear and help them avoid confusion. -{% capture code %} +```html example code centered columns={1} -{% include ui/form/input-mask.html mask="(00) 0000-0000" placeholder="(00) 0000-0000" visible=true %} -{% endcapture %} -{% include example.html code=code %} + +``` + diff --git a/docs/forms/form-selectboxes.mdx b/docs/forms/form-selectboxes.mdx new file mode 100644 index 000000000..08798539a --- /dev/null +++ b/docs/forms/form-selectboxes.mdx @@ -0,0 +1,303 @@ +--- +title: Form selectboxes +--- + +Add selectboxes to make your form more intuitive by providing users with a set of options to choose from. You can add simple selectboxes with a label, use icons only or icons with labels. Alternatively, you can use pill selectboxes if they go well with your design. + +```html example +
+ +
+ + + + +
+
+
+ +
+ + + + + +
+
+
+ +
+ + + + +
+
+
+ +
+ + + + +
+
+``` + +```html +
+ +
+ + + + +
+
+
+ +
+ + + + + +
+
+
+ +
+ + + + +
+
+
+ +
+ + + + +
+
+``` + +## Advanced selectboxes + +Use more advanced selectboxes to display the range of available options. You can choose selectboxes with radio buttons, if you want users to select only one option or with checkboxes, if they are allowed to choose multiple options. + +```html example height="300" centered columns="1" plugins="payments" +
+ +
+ + + +
+
+``` + +```html + +``` + diff --git a/docs/forms/form-validation.mdx b/docs/forms/form-validation.mdx new file mode 100644 index 000000000..82c9da7ff --- /dev/null +++ b/docs/forms/form-validation.mdx @@ -0,0 +1,25 @@ +--- +title: Validation states +description: To inform users whether the entered value is correct or not, use either of the validation states. Thanks to that, users will immediately know which form elements they need to correct and, if the state displays as invalid, why the value is incorrect. +--- + +```html example code centered columns="1" +
+ + + +
Invalid feedback
+
+``` + +## Subtle validation states + +If you prefer a more subtle manner of informing users of the input control validation state, you can use tick and cross symbols and resign from colored control frames and the validation feedback. + +```html example code centered columns="1" +
+ + + +
+``` diff --git a/docs/getting-started/browser-support.mdx b/docs/getting-started/browser-support.mdx new file mode 100644 index 000000000..98621926d --- /dev/null +++ b/docs/getting-started/browser-support.mdx @@ -0,0 +1,20 @@ +--- +title: Browser Support +--- + +As of this latest release, Tabler has launched many new features that may not be compatible with all browsers, especially older ones. + +For instance, Tabler no longer uses **vendor prefixes** in styles that are known to have some compatibility issues except for a few parts. Tabler also supports new features such as **CSS grid**, **object fit**, and **sticky positioning** which is not yet supported on all browsers. In short, Tabler supports all the latest supported browsers with **only** partial support for Internet Explorer. + +## Supported Browsers + +Browser|Version +---|---------- +|last 3 versions +|last 3 versions, ESR +|last 3 versions +|last 3 versions +|last 3 versions +|last 3 versions +|last 3 versions +|last 3 versions diff --git a/src/pages/_docs/customize.md b/docs/getting-started/customize.mdx similarity index 95% rename from src/pages/_docs/customize.md rename to docs/getting-started/customize.mdx index 079b8351f..a5045ec9a 100644 --- a/src/pages/_docs/customize.md +++ b/docs/getting-started/customize.mdx @@ -1,5 +1,4 @@ --- -menu: help.docs.content.customize title: Customize Tabler description: Tabler has been designed so that it can be adjusted to your needs and requirements as much as possible. You can customize your own fonts, colors, font sizes, etc in it. --- @@ -22,4 +21,4 @@ Now you just need to tell Tabler to use your favorite font: --tblr-font-sans-serif: 'Inter'; } -``` \ No newline at end of file +``` diff --git a/src/pages/_docs/download.md b/docs/getting-started/download.mdx similarity index 56% rename from src/pages/_docs/download.md rename to docs/getting-started/download.mdx index 084481fdd..d9cde3850 100644 --- a/src/pages/_docs/download.md +++ b/docs/getting-started/download.mdx @@ -1,27 +1,23 @@ --- title: Download -menu: help.docs.base.download description: Download Tabler to get the compiled CSS and JavaScript, source code, or include it with your favorite package managers like npm, yarn and more. --- - ## CDN via jsDelivr -All files included in `{{ site.npm-package }}` npm package are available over a jsDelivr CDN. Use it to deliver cached version of Tabler’s compiled CSS and JS to your project. +All files included in `@tabler/core` npm package are available over a jsDelivr CDN. Use it to deliver cached version of Tabler’s compiled CSS and JS to your project. ```html - - + + ``` You can also include additional Tabler plugins: ```html -{% removeemptylines %} -{% for plugin in site.tabler-css-plugins %} - -{% endfor %} -{% endremoveemptylines %} + + + ``` ## Package managers @@ -29,10 +25,10 @@ You can also include additional Tabler plugins: Install Tabler in your Node.js powered apps with the npm package: ``` -npm install {{ site.npm-package }} +npm install @tabler/core ``` -Tabler uses other packages to enhance the functionality for example charts and input masks. These are not automatically installed to avoid huge +Tabler uses other packages to enhance the functionality for example charts and input masks. These are not automatically installed to avoid huge dependency trees and need to be installed by using npm install. We support the following packages as of writing. - [apexcharts](https://apexcharts.com/) @@ -45,4 +41,4 @@ dependency trees and need to be installed by using npm install. We support the f - [nouislider](https://refreshless.com/nouislider/) - [tom-select](https://tom-select.js.org/) -For the complete list of supported packages you can check the peerDependencies section in our [package.json]({{ site.github-url }}/blob/dev/package.json) \ No newline at end of file +For the complete list of supported packages you can check the peerDependencies section in our [package.json](https://github.com/tabler/tabler/blob/dev/package.json) diff --git a/docs/getting-started/faq.mdx b/docs/getting-started/faq.mdx new file mode 100644 index 000000000..c79d5918c --- /dev/null +++ b/docs/getting-started/faq.mdx @@ -0,0 +1,23 @@ +--- +title: FAQ +description: Answers to the most frequently asked questions. +--- + +## Table of contents + +## I found an issue, what can I do? + +If you think you have found an issue that can only be fixed by the maintainers, feel free to open an issue on [GitHub](https://github.com/tabler/tabler). + +## Will there be a version for Vue or React? + +We are evaluating adding support for Vue 3 and React to all of our components, but it is not a top priority at the moment. + +## Can I use Tabler in open source projects? + +Yes, absolutely. + +## Can I use Tabler in commercial projects? + +Yes. You can read about our license here: [License](/license) + diff --git a/src/pages/_docs/getting-started.md b/docs/getting-started/index.mdx similarity index 77% rename from src/pages/_docs/getting-started.md rename to docs/getting-started/index.mdx index 094ab7cb7..27b39405c 100644 --- a/src/pages/_docs/getting-started.md +++ b/docs/getting-started/index.mdx @@ -1,12 +1,18 @@ --- -title: Getting started -menu: help.docs.base.getting-started +title: Introduction +description: Free and open-source HTML Dashboard UI Kit built on Bootstrap --- +## What is Tabler? + +Tabler is fully responsive and compatible with all modern browsers. Thanks to its modern and user-friendly design you can create a fully functional interface that users will love! Choose the layouts and components you need and customize them to make your design consistent and eye-catching. Every component has been created with attention to detail to make your interface beautiful! + ## 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 responsive. Thanks to the big choice of ready-made components, you can customize 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. +![](https://raw.githubusercontent.com/tabler/tabler/dev/src/static/tabler-preview.png) + ## 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: @@ -29,7 +35,6 @@ Once you've completed the setup, you'll be able to run the various commands prov 2. Open [http://localhost:3000](http://localhost:3000) in your browser, and voilà. 3. Any change in `/src` directory will build the application and refresh the page. - ## Bugs and feature requests -Found a bug or have a feature request? [Please open a new issue](https://github.com/tabler/tabler/issues/new). \ No newline at end of file +Found a bug or have a feature request? [Please open a new issue](https://github.com/tabler/tabler/issues/new). diff --git a/docs/icons/index.mdx b/docs/icons/index.mdx new file mode 100644 index 000000000..433c75f75 --- /dev/null +++ b/docs/icons/index.mdx @@ -0,0 +1,103 @@ +--- +title: Tabler Icons +description: Tabler Icons is a powerful and versatile icon library that offers a huge collection of high quality icons suitable for a wide range of applications. With its clean and modern aesthetic, extensive customisation options, and user-friendly website and plugins, Tabler Icons is an excellent resource for designers and developers looking to enhance their projects with high-quality icons. +--- + +```html example centered separated + + + + + + + + + + + + + + + + + + + + + + +``` + +## Customize stroke + +The `stroke-width` property is a powerful tool for customizing icons. This property allows you to control the thickness of the stroke used to outline an icon, giving you precise control over its appearance. By adjusting the `stroke-width` property, you can make an icon more or less prominent, change its emphasis, or create unique visual effects. For example, a thinner stroke may be ideal for icons with intricate designs or fine details, while a thicker stroke can add visual weight and impact to simpler, bolder icons. + +All icons are designed by default with `2px` stroke. + +```html example centered separated + + + + + + + + + + + + + + + + + + + + + + + + +``` + +```html + + ... + + + ... + + + ... + +``` + +## Filled version of icons + +```html example centered separated + + + + + + + + + + + + + + + + + +``` + +## Browse icons + +Tabler Icons is a comprehensive icon library that features over high-quality icons. These icons are designed with a clean and modern aesthetic, making them suitable for a wide range of applications. + +To use Tabler Icons, you can visit their website at https://tabler-icons.io. From there, you can browse the full collection of icons by category or search for a specific icon using the search bar. Once you have found an icon you like, you can download it in various file formats, including SVG, PNG, and Icon Font. + diff --git a/docs/layout/page-headers.mdx b/docs/layout/page-headers.mdx new file mode 100644 index 000000000..564757e58 --- /dev/null +++ b/docs/layout/page-headers.mdx @@ -0,0 +1,224 @@ +--- +title: Page headers +description: Page heading examples for Tabler +--- + +## Simple header + +```html example code vcentered + +``` + +## With meta, avatar and actions + +```html example code vcentered + +``` + +## With meta, search and actions + +```html example code vcentered + +``` + +## Bordered header + +Page header with a border to separate content is an effective way to organize and present information in a clear and visually appealing way. + +```html example code vcentered + +``` + +## Header with breadcrumb and actions + +A page header with breadcrumb and actions is a common design element found in many websites and applications. The header typically appears at the top of the page and includes a breadcrumb trail, which shows the user the path they have taken to reach the current page. The breadcrumb can be clickable, allowing the user to navigate back to previous pages. + +In addition to the breadcrumb, the header often includes actions or buttons that allow the user to perform common tasks related to the current page. These actions may include things like adding a new item, editing existing content, or deleting items. + +```html example code vcentered + +``` + diff --git a/docs/menu.json b/docs/menu.json new file mode 100644 index 000000000..e5dbf6b6e --- /dev/null +++ b/docs/menu.json @@ -0,0 +1,211 @@ +{ + "getting-started": { + "title": "Getting started", + "pages": { + "index": { + "title": "Introduction" + }, + "browser-support": { + "title": "Browser Support" + }, + "customize": { + "title": "Customize Tabler" + }, + "download": { + "title": "Download" + }, + "faq": { + "title": "FAQ" + } + } + }, + "base": { + "title": "Base", + "pages": { + "colors": { + "title": "Colors", + "label": "new" + }, + "typography": { + "title": "Typography" + } + } + }, + "components": { + "title": "Components", + "pages": { + "alerts": { + "title": "Alerts" + }, + "autosize": { + "title": "Autosize" + }, + "avatars": { + "title": "Avatars" + }, + "badges": { + "title": "Badges" + }, + "breadcrumb": { + "title": "Breadcrumb" + }, + "buttons": { + "title": "Buttons" + }, + "cards": { + "title": "Cards" + }, + "carousel": { + "title": "Carousel" + }, + "charts": { + "title": "Charts" + }, + "datagrid": { + "title": "Datagrid" + }, + "divider": { + "title": "Divider" + }, + "dropdowns": { + "title": "Dropdowns" + }, + "dropzone": { + "title": "Dropzone" + }, + "empty": { + "title": "Empty" + }, + "icons": { + "title": "Icons" + }, + "inline-player": { + "title": "Inline Player" + }, + "modals": { + "title": "Modals" + }, + "placeholder": { + "title": "Placeholder" + }, + "popover": { + "title": "Popover" + }, + "progress": { + "title": "Progress" + }, + "progressbg": { + "title": "Progress background" + }, + "range-slider": { + "title": "Range slider" + }, + "ribbons": { + "title": "Ribbons" + }, + "spinners": { + "title": "Spinners" + }, + "statuses": { + "title": "Statuses" + }, + "steps": { + "title": "Steps" + }, + "switch-icon": { + "title": "Switch icon" + }, + "tables": { + "title": "Tables" + }, + "tabs": { + "title": "Tabs" + }, + "timelines": { + "title": "Timelines" + }, + "tinymce": { + "title": "Tinymce" + }, + "toasts": { + "title": "Toasts" + }, + "tooltips": { + "title": "Tooltips" + }, + "tracking": { + "title": "Tracking" + } + } + }, + "forms": { + "title": "Forms", + "pages": { + "form-elements": { + "title": "Base elements" + }, + "form-fieldset": { + "title": "Fieldset" + }, + "form-color-check": { + "title": "Color check" + }, + "form-image-check": { + "title": "Image check" + }, + "form-selectboxes": { + "title": "Selectbox" + }, + "form-validation": { + "title": "Validation" + }, + "form-input-mask": { + "title": "Input mask" + }, + "form-helpers": { + "title": "Form helpers" + } + } + }, + "layout": { + "title": "Layout", + "pages": { + "page-headers": { + "title": "Page headers" + } + } + }, + "plugins": { + "title": "Plugins", + "pages": { + "flags": { + "title": "Flags" + }, + "payments": { + "title": "Payments" + } + } + }, + "utilities": { + "title": "Utilities", + "pages": { + "borders": { + "title": "Borders" + }, + "cursors": { + "title": "Cursors" + }, + "interactions": { + "title": "Interactions" + } + } + }, + "icons": { + "title": "Icons", + "pages": { + "index": { + "title": "Introduction" + } + } + } +} diff --git a/docs/plugins/flags.mdx b/docs/plugins/flags.mdx new file mode 100644 index 000000000..751a90529 --- /dev/null +++ b/docs/plugins/flags.mdx @@ -0,0 +1,54 @@ +--- +title: Flags +description: Thanks to the Tabler flags plugin, you can create flags to visually represent countries or languages. Flags are often used in forms, as an element of a delivery address, phone number dialling code and many more. +plugin: flags +libs: tabler-flags +--- + +import config from '../config.json' + +## Installation + +This part of Tabler is distributed as plugin. To enable it you should include `tabler-flags.css` or `tabler-flags.min.css` file to your page. + +You can also include plugin via CDN: + +```html + +``` + +## Flag + +To create a flag, add the `flag` class to a component and choose the country whose flag you want to use. The full list of countries can be found below. + +```html code example centered separated plugins="flags" + + + +``` + +## Flag sizes + +Using Bootstrap’s typical naming structure, you can create a standard flag, or scale it up or down to different sizes based on what’s needed. + +```html example centered separated plugins="flags" + + + + + +``` + +```html + + + + + +``` + +## Types + +To use the flag of a particular country, add the `flag-country-(country name)` class. For example, to create a flag of Andorra should use the following class: `.flag-country-ad`. + + diff --git a/docs/plugins/payments.mdx b/docs/plugins/payments.mdx new file mode 100644 index 000000000..840d616e2 --- /dev/null +++ b/docs/plugins/payments.mdx @@ -0,0 +1,45 @@ +--- +title: Payments +description: The Tabler payments plug-in will let you use a set of payment provider icons to facilitate the payment process and make it more-user friendly. +plugin: payments +--- + +import config from '../config.json' + +## Installation + +This part of Tabler is distributed as plugin. To enable it you should include `tabler-payments.css` or `tabler-payments.min.css` file to your page. + +You can also include plugin via CDN: + +```html + +``` + +## Payment + +To create a payment provider icon, add the `payment` class to a component and specify the payment provider. The full list of payment providers can be found below. + +```html example code plugins="payments" separated centered + + + +``` + +## Payment sizes + +Using Bootstrap’s typical naming structure, you can create a standard payment, or scale it up or down to different sizes based on what’s needed. + +```html example code plugins="payments" separated centered + + + + + +``` + +## List of available payment providers + +Select an icon from the list of payment providers. Each icon comes in two color variants - light and dark, so you can choose the one that goes well with your design. + + diff --git a/docs/utilities/borders.mdx b/docs/utilities/borders.mdx new file mode 100644 index 000000000..08998cbb7 --- /dev/null +++ b/docs/utilities/borders.mdx @@ -0,0 +1,114 @@ +--- +title: Borders +description: Use border utilities to quickly style the border and border-radius of an element. Great for images, buttons, or any other element. +--- + +## Border direction + +The following border utilities classes will add border to any side of an element. + +```html example centered separated background="white" +
1
+
2
+
3
+
4
+
5
+
6
+
7
+``` + +```html +
1
+
2
+
3
+
4
+
5
+
6
+
7
+``` + +## Border size + +Below are the available border size utilities classes. + +```html example centered separated background="white" +
1
+
2
+
3
+``` + +```html +
1
+
2
+
3
+``` + +## Remove border + +You can remove a border on a single side of an element by using the following border utilities classes. + +```html example centered separated background="white" +
1
+
2
+
3
+
4
+
5
+
6
+``` + +```html +
1
+
2
+
3
+
4
+
5
+
6
+``` + +## Border color + +You can set a border color of any side of an element by adding the following utilities classes below. + +```html example centered separated background="white" +
1
+
2
+
3
+
4
+
5
+
6
+
7
+
8
+``` + +```html +
1
+
2
+
3
+
4
+
5
+
6
+
7
+
8
+``` + +## Border radius + +You can set a border to any element by using the following utilities classes below. + +```html example centered separated background="white" +
1
+
2
+
3
+
4
+
5
+
6
+``` + +```html +
1
+
2
+
3
+
4
+
5
+
6
+``` diff --git a/docs/utilities/cursors.mdx b/docs/utilities/cursors.mdx new file mode 100644 index 000000000..aa4f5a74b --- /dev/null +++ b/docs/utilities/cursors.mdx @@ -0,0 +1,92 @@ +--- +title: Cursors +description: You can use different cursors to reflect the intended user interaction with particular elements of an interface. The cursor will change when a user hovers over a given element to indicate the action which can be performed. +--- + +## Cursor utilities + +Use one of the available cursor utilities depending on the action you want to indicate. + +- `.cursor-auto`- the cursor style depends on what's inside a given element +- `.cursor-pointer` - a pointing cursor, used to show that an element is clickable +- `.cursor-move` - a cursor which shows that a given element can be moved +- `.cursor-not-allowed` - a cursor which shows that a user is not allowed to perform an action on an element +- `.cursor-zoom-in` - a cursor which shows that a user can zoom in +- `.cursor-zoom-out` - a cursor which shows that a user can zoom out +- `.cursor-default` - the default cursor +- `.cursor-none` - no cursor +- `.cursor-help` - a cursor which shows that help information is available +- `.cursor-progress` - a cursor which shows that an action is in progress +- `.cursor-wait` - a cursor which shows that a user cannot interact with the element because it is busy +- `.cursor-text` - a cursor which shows that a user can type +- `.cursor-v-text` - a cursor which shows that a user can type in a vertical text input +- `.cursor-grab` - a cursor which shows that a user can grab an element +- `.cursor-grabbing` - a cursor which shows that a user is grabbing an element + +```html example background="white" +
+
+
auto
+
+
+
pointer
+
+
+
move
+
+
+
not-allowed
+
+
+
zoom-in
+
+
+
zoom-out
+
+
+
default
+
+
+
none
+
+
+
help
+
+
+
progress
+
+
+
wait
+
+
+
text
+
+
+
vertical-text
+
+
+
grab
+
+
+
grabbing
+
+
+``` + +```html +
auto
+
pointer
+
move
+
not-allowed
+
zoom-in
+
zoom-out
+
default
+
none
+
help
+
progress
+
wait
+
text
+
vertical-text
+
grab
+
grabbing
+``` diff --git a/src/pages/_docs/interactions.md b/docs/utilities/interactions.mdx similarity index 72% rename from src/pages/_docs/interactions.md rename to docs/utilities/interactions.mdx index 2e5243790..5769e56af 100644 --- a/src/pages/_docs/interactions.md +++ b/docs/utilities/interactions.mdx @@ -1,26 +1,23 @@ --- title: Interactions description: Utility classes that change how users interact with contents of a website. -menu: help.docs.utils.interactions --- ## Text selection Change the way in which the content is selected when the user interacts with it. -{% capture code %} +```html code example

This paragraph will be entirely selected when clicked by the user.

This paragraph has default select behavior.

This paragraph will not be selectable when clicked by the user.

-{% endcapture %} -{% include example.html code=code %} +``` ## Pointer events -Tabler provides .pe-none and .pe-auto classes to prevent or add element interactions. +Tabler provides `.pe-none` and `.pe-auto` classes to prevent or add element interactions. -{% capture code %} +```html code example

This link can not be clicked.

This link can be clicked (this is default behavior).

-{% endcapture %} -{% include example.html code=code %} \ No newline at end of file +``` diff --git a/src/pages/_data/menu.yml b/src/pages/_data/menu.yml index fa75427fc..1043c4e40 100644 --- a/src/pages/_data/menu.yml +++ b/src/pages/_data/menu.yml @@ -303,7 +303,7 @@ help: children: docs: title: Documentation - url: docs/ + url: https://github.com/tabler/tabler changelog: url: changelog.html title: Changelog diff --git a/src/pages/_docs/alerts.md b/src/pages/_docs/alerts.md deleted file mode 100644 index 258335488..000000000 --- a/src/pages/_docs/alerts.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: Alerts -menu: help.docs.components.alerts -description: Alert messages are used to inform users of the status of their action and help them solve any problems that might have occurred. Good design of alert modals is very important for the overall user experience of a website or app. -bootstrap-link: components/alerts/ ---- - - -## Default markup - -Depending on the information you need to convey, you can use one of the following types of alert messages - **success**, **info**, **warning** or **danger**. Using the right type of alert modal will help draw users' attention to the message and prompt them to take action. - -{% capture code %} -{% for alert in site.data.alerts %} - {% include ui/alert.html type=alert.color text=alert.text description=alert.description %} -{% endfor %} -{% endcapture %} -{% include example.html code=code %} - - -## Alert links - -Add a link to your alert message to redirect users to the details they need to complete or additional information they should read. - -{% capture code %} -{% for variant in site.variants %} - {% capture variant-text %} - This is a {{ variant.name }} alert — check it out! - {% endcapture %} - {% include ui/alert.html type=variant.name text=variant-text %} -{% endfor %} -{% endcapture %} -{% include example.html code=code %} - - -## Dismissible alerts - -Add the `x` close button to make an alert modal dismissible. Thanks to that, your alert modal will disappear only once the user closes it. - -{% capture code %} -{% for alert in site.data.alerts %} -{% include ui/alert.html type=alert.color icon=alert.icon text=alert.text description=alert.description close=true %} -{% endfor %} -{% endcapture %} -{% include example.html code=code %} - - -## Alerts with icons - -Add an icon to your alert modal to make it more user-friendly and help users easily identify the message. - -{% capture code %} -{% for alert in site.data.alerts %} -{% include ui/alert.html type=alert.color icon=alert.icon text=alert.text description=alert.description %} -{% endfor %} -{% endcapture %} -{% include example.html code=code %} - - -## Alert with avatar - -Add an avatar to your alert modal to make it more personalized. - -{% capture code %} -{% for variant in site.variants %} - {% capture variant-text %} - Lorem ipsum dolor sit amet, consectetur adipisicing elit. Lorem ipsum dolor sit amet, consectetur adipisicing elit. Lorem ipsum dolor sit amet, consectetur adipisicing elit. - {% endcapture %} - {% include ui/alert.html type=variant.name text=variant-text person-id=forloop.index %} -{% endfor %} -{% endcapture %} -{% include example.html code=code %} - - -## Alert with buttons - -Add primary and secondary buttons to your alert modals if you want users to take a particular action based on the information included in the modal message. - -{% capture code %} -{% capture variant-text %} -

Some Title

-

Lorem ipsum Minim ad pariatur eiusmod ea ut nulla aliqua est quis id dolore minim voluptate.

-{% endcapture %} -{% for alert in site.data.alerts %} -{% include ui/alert.html type=alert.color text=variant-text close=true buttons=true %} -{% endfor %} -{% endcapture %} -{% include example.html code=code %} - - -## Important alerts - -If you want your alert to be really eye-catching, you can add a class `alert-important`. - -{% capture code %} -{% for alert in site.data.alerts %} -{% include ui/alert.html type=alert.color text=alert.description close=true important=true icon=alert.icon %} -{% endfor %} -{% endcapture %} -{% include example.html code=code %} - diff --git a/src/pages/_docs/avatars.md b/src/pages/_docs/avatars.md deleted file mode 100644 index 4274112c8..000000000 --- a/src/pages/_docs/avatars.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: Avatars -menu: help.docs.components.avatars -description: Avatars help customise various elements of a user interface and make the product experience more personalised. They are often used in communication apps, collaboration tools and social media. ---- - - -## Default markup - -Use the `avatar` class to add an avatar to your interface design for greater customisation. - -{% capture code %} -{% include ui/avatar.html person-id=1 %} -{% include ui/avatar.html person-id=2 %} -{% include ui/avatar.html person-id=3 %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Avatar image - -Set an image as the background to make users easy to indentify and create a personalised experience. - -{% capture code %} -{% include ui/avatar.html person-id=1 %} -{% include ui/avatar.html person-id=3 %} -{% include ui/avatar.html person-id=4 %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Initials - -You can also use initials instead of pictures. - -{% capture code %} -{% include ui/avatar.html placeholder="AB" %} -{% include ui/avatar.html placeholder="CD" %} -{% include ui/avatar.html placeholder="EF" %} -{% include ui/avatar.html placeholder="GH" %} -{% include ui/avatar.html placeholder="IJ" %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Avatar icons - -Apart from pictures and initials, you can also use icons to make the avatars more universal. - -{% capture code %} -{% include ui/avatar.html icon="user" %} -{% include ui/avatar.html icon="plus" %} -{% include ui/avatar.html icon="user-plus" %} -{% 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. - -{% capture code %} -{% include ui/avatar.html placeholder="AB" color="green" %} -{% include ui/avatar.html placeholder="CD" color="red" %} -{% include ui/avatar.html placeholder="EF" color="yellow" %} -{% include ui/avatar.html placeholder="GH" color="primary" %} -{% include ui/avatar.html placeholder="IJ" color="purple" %} -{% 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 or down to different sizes based on what you need. - -{% capture code %} -{% include ui/avatar.html person-id=10 size="xl" %} -{% include ui/avatar.html person-id=9 size="lg" %} -{% include ui/avatar.html person-id=8 size="md" %} -{% include ui/avatar.html person-id=7 %} -{% include ui/avatar.html person-id=6 size="sm" %} -{% include ui/avatar.html person-id=5 size="xs" %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Avatar status - -Add a status indicator to your avatar to show, for instance, if a users is online or offline or indicate the number of messages they have received. - -{% capture code %} -{% include ui/avatar.html person-id=11 %} -{% include ui/avatar.html person-id=12 status="danger" %} -{% include ui/avatar.html person-id=13 status="success" %} -{% include ui/avatar.html person-id=14 status="warning" %} -{% include ui/avatar.html person-id=15 status="info" %} -{% include ui/avatar.html person-id=16 status="gray" status-text="5" %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Avatar shape - -Change the shape of an avatar with the default Bootstrap image classes. You can make them round or square and change their border radius. - -{% capture code %} -{% include ui/avatar.html person-id=17 %} -{% include ui/avatar.html person-id=18 shape="rounded" %} -{% include ui/avatar.html person-id=19 shape="rounded-circle" %} -{% include ui/avatar.html person-id=20 shape="rounded-0" %} -{% include ui/avatar.html person-id=21 shape="rounded-3" %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Avatars list - -Create a list of avatars within one parent container. - -{% capture code %} -{% include ui/avatar-list.html %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Stacked list - -Make the list stack once a certain number of avatars is reached to make it look clear and display well regardless of the screen size. - -{% capture code %} -
- {% for person in site.data.people limit: 5 offset: 30 %} - {% include ui/avatar.html person=person element="a" %} - {% endfor %} - +8 -
-{% endcapture %} -{% include example.html code=code centered=true %} - -{% capture code %} -
- {% for person in site.data.people limit: 8 offset: 10 %} - {% include ui/avatar.html person=person element="a" class="rounded-circle" size="sm" %} - {% endfor %} -
-{% endcapture %} -{% include example.html code=code centered=true %} diff --git a/src/pages/_docs/badges.md b/src/pages/_docs/badges.md deleted file mode 100644 index 6cc292ff6..000000000 --- a/src/pages/_docs/badges.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: Badges -menu: help.docs.components.badges -description: Badges are small count and labeling components, which are used to add extra information to an interface element. You can use them to draw users' attention to a new element, notify about unread messages or provide any kind of additional info. -bootstrap-link: components/badge/ ---- - - -## Default markup - -The default badges are square and come in the basic set of colors. - -{% capture code %} -{% for color in site.colors %} -{{ color[1].title }} -{% endfor %} -{% endcapture %} -{% include example.html code=code centered=true %} - -## Headings - -{% capture code %} -

Example heading New

-

Example heading New

-

Example heading New

-

Example heading New

-
Example heading New
-
Example heading New
-{% endcapture %} -{% include example.html code=code %} - -## Outline badges - -{% capture code %} -{% for color in site.colors %} -{{ color[0] }} -{% endfor %} -{% endcapture %} -{% include example.html code=code centered=true %} - -## Pill badges - -Use the `.badge-pill` class if you want to create a badge with rounded corners. Its width will adjust to the label text. - -{% capture code %} -{% for color in site.colors %} -{{ forloop.index }} -{% endfor %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Soft color badges - -You can create a soft colour variant of a corresponding contextual badge variation, to make it look more subtle. Click [here]({% docs_url colors %}) to see the list of available colors and choose ones that best suit your design. - -{% capture code %} -{% for color in site.colors %} -{{ color[1].title }} -{% endfor %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Links - -Place the badge within an `` element if you want it to perform the function of a link and make it clickable. - -{% capture code %} -{% for color in site.colors %} -{{ color[1].title }} -{% endfor %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Button with badge - -Badges can be used as part of links or buttons to provide a counter. - -{% capture code %} - - -{% endcapture %} -{% include example.html code=code wrapper="btn-list" %} \ No newline at end of file diff --git a/src/pages/_docs/borders.md b/src/pages/_docs/borders.md deleted file mode 100644 index 3a24e841e..000000000 --- a/src/pages/_docs/borders.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Borders -menu: help.docs.utils.borders -description: Use border utilities to quickly style the border and border-radius of an element. Great for images, buttons, or any other element. ---- - -## Border direction - -The following border utilities classes will add border to any side of an element. - -{% capture code %} -
-
-
-
-
-
-
-{% endcapture %} -{% include example.html code=code centered=true wrapper="d-flex space-x-3" %} - -## Border size - -Below are the available border size utilities classes. - -{% capture code %} -
-
-
-{% endcapture %} -{% include example.html code=code centered=true wrapper="d-flex space-x-3" %} - - -## Remove border - -You can remove a border on a single side of an element by using the following border utilities classes. - -{% capture code %} -
-
-
-
-
-
-{% endcapture %} -{% include example.html code=code centered=true wrapper="d-flex space-x-3" %} - -## Border color - -You can set a border color of any side of an element by adding the following utilities classes below. - -{% capture code %} -{% for color in site.theme-colors %} -
-{% endfor %} -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Border radius - -You can set a border to any element by using the following utilities classes below. - -{% capture code %} -
-
-
-
-
-
-{% endcapture %} -{% include example.html code=code centered=true wrapper="d-flex space-x-3" %} \ No newline at end of file diff --git a/src/pages/_docs/breadcrumb.md b/src/pages/_docs/breadcrumb.md deleted file mode 100644 index ef91752a3..000000000 --- a/src/pages/_docs/breadcrumb.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Breadcrumb -menu: help.docs.components.breadcrumb -description: Breadcrumbs are used to show the current website or app location and reduce the number of actions users have to take. Thanks to breadcrumbs, they can easily navigate within the website hierarchy and better understand its structure. -bootstrap-link: components/breadcrumb/ ---- - - -## Default markup - -Add the `:before` pseudo-element in `li` tags to use the default separators. The `active` modifier in a `li` tag will help you indicate the current page location and facilitate navigation within your website or app. - -{% capture code %} -{% include ui/breadcrumb.html %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Breadcrumb variations - -If you wish to use different separators, modify the `$breadcrumb-variants` variable in the Tabler config. Depending on the aesthetics of your design, you can choose dots, bullets or arrows. - -{% capture code %} -{% include ui/breadcrumb.html class="breadcrumb-dots" %} -{% endcapture %} -{% include example.html code=code centered=true %} - -{% capture code %} -{% include ui/breadcrumb.html class="breadcrumb-arrows" %} -{% endcapture %} -{% include example.html code=code centered=true %} - -{% capture code %} -{% include ui/breadcrumb.html class="breadcrumb-bullets" %} -{% endcapture %} -{% include example.html code=code centered=true %} - -## Breadcrumb in headers - -If you wish to use breadcrumbs in headers, place them above the headers. - -{% capture code %} -{% include layout/headers/page-header-4.html %} -{% endcapture %} -{% include example.html code=code columns=2 %} \ No newline at end of file diff --git a/src/pages/_docs/browser-support.md b/src/pages/_docs/browser-support.md deleted file mode 100644 index 9d1796c73..000000000 --- a/src/pages/_docs/browser-support.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Browser Support -menu: help.docs.base.browser-support ---- - -As of this latest release, Tabler has launched many new features that may not be compatible with all browsers, especially older ones. - -For instance, Tabler no longer uses **vendor prefixes** in styles that are known to have some compatibility issues except for a few parts. Tabler also supports new features such as **CSS grid**, **object fit**, and **sticky positioning** which is not yet supported on all browsers. In short, Tabler supports all the latest supported browsers with **only** partial support for Internet Explorer. - -## Supported Browsers - -Browser|Version ----|---------- - Edge|last 3 versions - Firefox|last 3 versions, ESR - Chrome|last 3 versions - Safari|last 3 versions - Opera|last 3 versions - Electron|last 3 versions - Brave|last 3 versions - Vivaldi|last 3 versions \ No newline at end of file diff --git a/src/pages/_docs/buttons.md b/src/pages/_docs/buttons.md deleted file mode 100644 index 218d261a4..000000000 --- a/src/pages/_docs/buttons.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -title: Buttons -description: Use button styles that best suit your designs and encourage users to take the desired actions. You can customize the button's properties to improve the user experience of your website or system, changing the size, shape, color and many more. -bootstrap-link: components/buttons/ -menu: help.docs.components.buttons ---- - - -## Button tag - -As one of the most common elements of UI design, buttons have a very important function of engaging users with your website or app and guiding them in their actions. Use the `.btn` classes with the ` - - - -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Default button - -The standard button creates a white background and subtle hover animation. It's meant to look and behave as an interactive element of your page. - -{% capture code %} -Link -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - -## Button variations - -Use the button classes that correspond to the function of your button. The big range of available colors will help you show your buttons' purpose and make them easy to spot. - -{% capture code %} -{% for button in site.theme-colors %} -{% assign btn-color = button[1].class %} -{% assign btn-title = button[1].title %} -{% include ui/button.html color=btn-color text=btn-title %} -{% endfor %} -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Disabled buttons - -Make buttons look inactive to show that an action is possible once the user meets certain criteria, such as completing the required fields to submit a form. - -{% capture code %} -{% for button in site.theme-colors %} -{% assign btn-color = button[1].class %} -{% assign btn-title = button[1].title %} -{% include ui/button.html color=btn-color text=btn-title disabled=true %} -{% endfor %} -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Color variations - -Choose the right color for your button to make it go well with your design and draw users' attention. Button colors can have a big influence on users' decisions, which is why it's important to choose them based on the intended purpose. - -{% capture code %} -{% for button in site.colors %} -{{ button[1].title }} -{% endfor %} -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Ghost buttons - -Use the `.btn-ghost-*` class to make your button look simple yet aesthetically appealing. Ghost buttons help focus users' attention on the website's primary design, at the same time encouraging them to take action. - -{% capture code %} -{% for button in site.theme-colors %} -{{ button[1].title }} -{% endfor %} -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Square buttons - -Use the `.btn-square` class to remove the border radius, if you want the corners of your button to be square rather than rounded. - -{% capture code %} -{% include ui/button.html text="White" square=true %} -{% for button in site.button-variants %} -{% assign btn-color = button[1].class %} -{% assign btn-title = button[1].title %} -{% include ui/button.html color=btn-color text=btn-title square=true %} -{% endfor %} -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Pill buttons - -Add the `.btn-pill` class to your button to make it rounded and give it a modern and attractive look. - -{% capture code %} -{% include ui/button.html text="White" pill=true %} -{% for button in site.button-variants %} -{% assign btn-color = button[1].class %} -{% assign btn-title = button[1].title %} -{% include ui/button.html color=btn-color text=btn-title pill=true %} -{% endfor %} -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Outline buttons - -Replace the default modifier class with the `.btn-outline-*` class, if you want to remove the color and the background of your button and give it a more subtle look. Outline buttons are perfect to use as secondary buttons, as they don't distract users from the main action. - -{% capture code %} -{% for button in site.theme-colors %} -{% assign btn-color = button[1].class %} -{% assign btn-title = button[1].title %} -{% include ui/button.html text=btn-title color=btn-color outline=true %} -{% endfor %} -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Button size - -Add `.btn-lg` or `.btn-sm` to change the size of your button and differentiate those which should have primary focus from those of secondary importance. Adapt the button size to your design and encourage users to take actions. - -{% capture code %} - - -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - -{% capture code %} - - -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Buttons with icons - -Label your button with text and add an icon to communiacate the action and make it easy to identify for users. Icons are easily recognized and improve the aesthetics of your button design, giving it a modern and atractive look. - -Icons can be found [**here**](/docs/icons.html#icons) - -{% capture code %} - - - - - - -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Social buttons - -You can use the icons of popular social networking sites, which users are familiar with. Thanks to buttons with social media icons users can share content or follow a website with just one click, without leaving the website. - -{% capture code %} -{% for button in site.socials %} -{% assign btn-icon = button[1].icon %} -{% assign btn-title = button[1].title %} -{% assign btn-color = button[0] %} -{% include ui/button.html color=btn-color icon=btn-icon text=btn-title %} -{% endfor %} -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - -You can also add an icon without the name of a social networking site, if you want to display more buttons on a small space. - -{% capture code %} -{% for button in site.socials %} -{% assign btn-icon = button[1].icon %} -{% assign btn-color = button[0] %} -{% include ui/button.html color=btn-color icon=btn-icon icon-only=true %} -{% endfor %} -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Icon buttons - -Add the `.btn-icon` class to remove unnecessary padding from your button and use an icon without any additional label. Thanks to that, you can save space and make the action easy to recognize for international users. - -{% capture code %} -{% include ui/button.html icon="activity" color="primary" icon-only=true %} -{% include ui/button.html icon="brand-github" color="github" icon-only=true %} -{% include ui/button.html icon="bell" color="success" icon-only=true %} -{% include ui/button.html icon="star" color="warning" icon-only=true %} -{% include ui/button.html icon="trash" color="danger" icon-only=true %} -{% include ui/button.html icon="chart-bar" color="purple" icon-only=true %} -{% include ui/button.html icon="git-merge" icon-only=true %} -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Dropdown buttons - -Create a dropdown button that will encourage users to click for more options. You can add a label with an icon or remove the label and add an icon on its own if you want to save space. Choose the option that will best suit your design and improve the user experience. - -{% capture code %} - - - - - -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - -## Loading buttons - -Add the `.btn-loading` class to show a button's loading state, which can be useful in the case of operations that take longer to process. Thanks to that, users will be aware of the current state of their action and won't give it up before it's finished. - - -{% capture code %} -{% include ui/button.html color="primary" text="Button" loading=true %} -{% include ui/button.html color="primary" text="Loading button with loooong content" loading=true %} -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} - - - -{% capture code %} -{% include ui/button.html color="primary" text="Button" spinner=true %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## List of buttons - -Create a list of buttons using the `.btn-list` container to display different actions a user can take. If you add aditional styling, such as colours, you will be able to focus users' attention on a particular action or suggest the result. - -{% capture code %} - -{% endcapture %} -{% include example.html code=code %} - -If the list is long, it will be wrapped and some buttons will be moved to the next line, keeping them all evenly spaced. - -{% capture code %} - -{% endcapture %} -{% include example.html code=code %} - -Use the `.text-center` or the `.text-end` modifiers to change the buttons' alignment and place them where they suit best. - -{% capture code %} - -{% endcapture %} -{% include example.html code=code %} - -{% capture code %} - -{% endcapture %} -{% include example.html code=code %} - -{% capture code %} - -{% endcapture %} -{% include example.html code=code %} - - -## Buttons with avatars - -Use buttons with avatars to simplify the process of interaction and make your design more personalized. Buttons can contain avatars and labels or only avatars, if displayed on a smaller space. - -{% capture code %} - - {% include ui/avatar.html person-id="4" %} Avatar - - - {% include ui/avatar.html person-id="5" %} Avatar - - - {% include ui/avatar.html person-id="6" %} Avatar - -{% endcapture %} -{% include example.html code=code wrapper="btn-list" centered=true %} diff --git a/src/pages/_docs/cards.md b/src/pages/_docs/cards.md deleted file mode 100644 index 914edfccb..000000000 --- a/src/pages/_docs/cards.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -title: Cards -menu: help.docs.components.cards -description: Cards are flexible user interface elements, which help organize content into meaningful sections and make it easier to display on different screen sizes. Cards contain various smaller components, such as images, text, links and buttons and may act as an entry to more detailed information, helping users scan the page quickly and find the most relevant content. -bootstrap-link: components/card/ ---- - - -## Default card - -Use the `.card` and `.card-body` classes to create a card and use it as the basis for a more advanced card design. A card is a perfect way to organize content and make it look neat and tidy. - -{% capture code %} -{% include cards/card.html body="This is some text within a card body." %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Card padding - -You can change the padding of a newly created card. To do it, use the `.card-sm`, `.card-md` or `.card-lg` classes. - -Cards with the `.card-sm` class are well suited for small items such as widgets, etc., while the `.card-lg` class can be used for large blocks of text. Padding will be automatically reduced on small devices, to fit the screen size. - -{% capture code %} -{% include cards/card.html class="card-sm" body="This is some text within a card body." %} -{% include cards/card.html body="This is some text within a card body." %} -{% include cards/card.html class="card-md" body="This is some text within a card body." %} -{% include cards/card.html class="card-lg" body="This is some text within a card body." %} -{% endcapture %} -{% include example.html code=code columns=2 wrapper="space-y" %} - - -## Card with title - -Add a title to your card by including the `.card-title` class within `.card-body`. You can also place the title inside the `.card-header` element to separate the title from the content with a horizontal line. - -{% capture code %} -{% include cards/card.html title="Card title" body="This is some text within a card body." %} -{% include cards/card.html header-title="Card title" body="This is some text within a card body." %} -{% endcapture %} -{% include example.html code=code columns=1 wrapper="space-y" %} - - -## Card with title and image - -To create a more visually appealing card, add a title and an image. Thanks to that, the card will go well with your interface design and draw users' attention. - -{% capture code %} -{% include cards/card.html img-top=true title="Card with title and image" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Blog post card - -Add an image to your blog post card to make it eye-catching. You can do it by adding the image in the `.card-img-top` class. Thanks to the `.d-flex` and `.flex-column` classes within `.card-body`, the author details will be displayed at the bottom of the card. - -{% capture code %} -{% include cards/blog-single.html type="image" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Row deck - -Add the `.row-deck` class to `.row`, if you want to display several cards next to one another. Thanks to that, they will all have the same height. - -{% capture code %} -
-
-
-
Short content
-
-
-
-
-
Extra long content of card. Lorem ipsum dolor sit amet, consetetur sadipscing elitr
-
-
-
-
-
Short content
-
-
-
-{% endcapture %} -{% include example.html code=code columns=2 %} - - -## Post card with aside image - -You can also add an image on the left side of the card. To do it, add the `.card-aside` class to the element with the `.card` class. Then add the image in the `.card-aside-column` element and it will be automatically centered and scaled to the right size. - -{% capture code %} -{% include cards/blog-single.html type="aside" liked=1 article-id=3 %} -{% endcapture %} -{% include example.html code=code columns=2 %} - - -## Color variations - -Add a status color to your card, either at the top or on the side of the card, to customise it and make it more eye-catching. - -{% capture code %} -
-
- {% include cards/card.html status-top="danger" title="Card with top status" %} -
-
- {% include cards/card.html status-left="green" title="Card with side status" %} -
-
-{% endcapture %} -{% include example.html code=code columns=2 %} - - -## Stacked card - -Use the `card-stacked` class to stack up multiple cards, if you want to save screen space or create a visually appealing effect. - -{% capture code %} -{% include cards/card.html class="card-stacked" title="Stacked card" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Tabbed card - -Organize multiple cards into tabs to be able to display more content in a well-organized way and allow users to alternate between them easily. - -{% capture code %} -{% include cards/card-tabs.html count=4 %} -{% endcapture %} -{% include example.html code=code columns=2 %} - diff --git a/src/pages/_docs/carousel.md b/src/pages/_docs/carousel.md deleted file mode 100644 index b9ece93cb..000000000 --- a/src/pages/_docs/carousel.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Carousel -menu: help.docs.components.carousel -description: A carousel is used to display multiple pieces of visual content without taking up too much space. Carousels eliminate the need to scroll down the page to see all content and are a popular method of displaying marketing information. -bootstrap-link: components/carousel/ ---- - - -## Default markup - -Use a carousel to make your website design more visually appealing for users. In the default carousel design, respective elements slide automatically and users can go to the next slide by clicking an arrow. - -{% capture code %} -{% include ui/carousel.html indicators=true controls=true id="carousel-sample" %} -{% endcapture %} -{% include example.html code=code max-width="30rem" centered=true %} - -## Dots indicators - -You can replace the standard indicators with dots. Just add the `carousel-indicators-dot` class to your carousel: - -{% capture code %} -{% include ui/carousel.html id="carousel-indicators-dot" title="Carousel with dot indicators" indicators=true indicators-dot=true offset=20 fade=true %} -{% endcapture %} -{% include example.html code=code max-width="30rem" centered=true %} - -## Thumb indicators - -The syntax is similar with thumbnails. Add class `carousel-indicators-thumb` and add `background-image` to element `[data-bs-target]`. Default thumbnails have an aspect ratio of 1:1. To change this use `ratio` utils. - -{% capture code %} -{% include ui/carousel.html id="carousel-indicators-thumb" title="Carousel with thumbnail indicators" indicators=true indicators-thumb=true indicators-thumb-ratio=true offset=25 fade=true %} -{% endcapture %} -{% include example.html code=code max-width="30rem" centered=true %} - -## Vertical indicators - -To make the indicators go to the right side, add the `carousel-indicators-vertical` class. You can combine it with other classes that are responsible for dots or thumbnails. - -{% capture code %} -{% include ui/carousel.html id="carousel-indicators-dot-vertical" title="Carousel with vertical dot indicators" indicators=true indicators-vertical=true indicators-dot=true offset=30 fade=true %} -{% endcapture %} -{% include example.html code=code max-width="30rem" centered=true %} - -Likewise, you can add thumbnails on the right side: - -{% capture code %} -{% include ui/carousel.html id="carousel-indicators-thumb-vertical" title="Carousel with thumbnail indicators" indicators=true indicators-vertical=true indicators-thumb=true indicators-thumb-ratio=true offset=22 fade=true %} -{% endcapture %} -{% include example.html code=code max-width="30rem" centered=true %} - -## Carousel with captions - -Add captions to your slides easily with the `.carousel-caption` element within any `.carousel-item`. To make the text more readable on the image you can add `carousel-caption-background` which will add a black overlay over the image. - -{% capture code %} -{% include ui/carousel.html id="carousel-captions" title="Carousel with captions" captions=true controls=true offset=15 %} -{% endcapture %} -{% include example.html code=code max-width="30rem" centered=true %} \ No newline at end of file diff --git a/src/pages/_docs/charts.md b/src/pages/_docs/charts.md deleted file mode 100644 index 870fc44b8..000000000 --- a/src/pages/_docs/charts.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Charts -menu: help.docs.plugins.charts -libs: apexcharts -description: Tabler uses ApexCharts - a free and open-source modern charting library that helps developers to create beautiful and interactive visualizations for web pages. ---- - -To be able to use the charts in your application you will need to install the apexcharts dependency with `npm install apexcharts`. - -See also the [ApexCharts](https://apexcharts.com/) documentation. - -## Line Chart - -Line charts are a typical pictorial representation that depicts trends and behaviors over time. - -{% capture code %} -{% include docs/chart.html chart="demo-line" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - -## Area Chart - -Area charts are used to represent quantitative variations. - -{% capture code %} -{% include docs/chart.html chart="demo-area" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - -## Bar Chart - -A bar chart is the best tool for displaying comparisons between categories of data. - -{% capture code %} -{% include docs/chart.html chart="demo-bar" %} -{% endcapture %} -{% include example.html code=code columns=2 %} - -## Pie Chart - -Pie charts are an instrumental visualization tool useful in expressing data and information in terms of percentages, ratio. - -{% capture code %} -{% include docs/chart.html chart="demo-pie" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - -# Heatmap Chart - -Heatmap is a visualization tool that employs color the way a bar chart employs height and width in representing data. - -{% capture code %} -{% include docs/chart.html chart="heatmap-basic" heatmap=true %} -{% endcapture %} -{% include example.html code=code columns=2 %} - -# Advanced example - -{% capture code %} -{% include docs/chart.html chart="social-referrals" %} -{% endcapture %} -{% include example.html code=code columns=2 %} \ No newline at end of file diff --git a/src/pages/_docs/cursors.md b/src/pages/_docs/cursors.md deleted file mode 100644 index d3de38fd8..000000000 --- a/src/pages/_docs/cursors.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: Cursors -description: You can use different cursors to reflect the intended user interaction with particular elements of an interface. The cursor will change when a user hovers over a given element to indicate the action which can be performed. -menu: help.docs.utils.cursors ---- - -## Cursor utilities - -Use one of the available cursor utilities depending on the action you want to indicate. - -- `.cursor-auto`- the cursor style depends on what's inside a given element -- `.cursor-pointer` - a pointing cursor, used to show that an element is clickable -- `.cursor-move` - a cursor which shows that a given element can be moved -- `.cursor-not-allowed` - a cursor which shows that a user is not allowed to perform an action on an element -- `.cursor-zoom-in` - a cursor which shows that a user can zoom in -- `.cursor-zoom-out` - a cursor which shows that a user can zoom out -- `.cursor-default` - the default cursor -- `.cursor-none` - no cursor -- `.cursor-help` - a cursor which shows that help information is available -- `.cursor-progress` - a cursor which shows that an action is in progress -- `.cursor-wait` - a cursor which shows that a user cannot interact with the element because it is busy -- `.cursor-text` - a cursor which shows that a user can type -- `.cursor-v-text` - a cursor which shows that a user can type in a vertical text input -- `.cursor-grab` - a cursor which shows that a user can grab an element -- `.cursor-grabbing` - a cursor which shows that a user is grabbing an element - -{% capture code %} -
-
-
Cursor auto
-
-
-
Cursor pointer
-
-
-
Cursor move
-
-
-
Cursor not allowed
-
-
-
Cursor zoom in
-
-
-
Cursor zoom out
-
-
-
Cursor default
-
-
-
Cursor none
-
-
-
Cursor help
-
-
-
Cursor progress
-
-
-
Cursor wait
-
-
-
Cursor text
-
-
-
Cursor vertical text
-
-
-
Cursor grab
-
-
-
Cursor grabbing
-
-
-{% endcapture %} -{% include example.html code=code %} diff --git a/src/pages/_docs/datagrid.md b/src/pages/_docs/datagrid.md deleted file mode 100644 index 40591410d..000000000 --- a/src/pages/_docs/datagrid.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Data grid -menu: help.docs.components.datagrid -description: Use the data grid component to display detailed information about your product. The data is displayed as a column of items consisting of a title and content. ---- - -{% capture code %} -{% include parts/datagrid.html %} -{% endcapture %} -{% include example.html code=code wrapper="demo-dividers" %} \ No newline at end of file diff --git a/src/pages/_docs/dropdowns.md b/src/pages/_docs/dropdowns.md deleted file mode 100644 index 119236b7b..000000000 --- a/src/pages/_docs/dropdowns.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: Dropdowns -description: Use dropdowns to display lists of options or include more positions in a menu without overwhelming users with too many buttons and long lists. Dropdowns facilitate users' interaction with your website or software and make your design look clear. -bootstrap-link: components/dropdowns -menu: help.docs.components.dropdowns ---- - - -## Default dropdown - -With small markup changes, you can turn any `.btn` into a dropdown toggle and use it to display more options for users to choose from. Start with the default dropdown and then use additional classes to make your dropdown more user-friendly. - -{% capture code %} -{% include ui/dropdown-menu.html show=true %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Dropdown divider - -Use dropdown dividers to separate groups of dropdown items for greater clarity. - -{% capture code %} -{% include ui/dropdown-menu.html show=true separated=true %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Active state - -Make a dropdown item look active, so that it highlights when a user hovers over a given option. - -{% capture code %} -{% include ui/dropdown-menu.html show=true active=true %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Disabled state - -Make a dropdown item look disabled to display options which are currently not available but can activate once certain conditions are met. - -{% capture code %} -{% include ui/dropdown-menu.html show=true disabled=true %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Dropdown header - -Add a dropdown header to group dropdown items into sections and name them accordingly. - -{% capture code %} -{% include ui/dropdown-menu.html show=true header=true %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Dropdown with icons - -Use icons in your dropdowns to add more visual content and make the options easy to identify for users. - -{% capture code %} -{% include ui/dropdown-menu.html show=true icons=true header=true %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Dropdown with arrow - -Add an arrow that points at the dropdown button. - -{% capture code %} -{% include ui/dropdown-menu.html show=true arrow=true %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Dropdown with badge - -Add a badge to your dropdown items to show additional information related to an item or distinguish it from other elements. - -{% capture code %} -{% include ui/dropdown-menu.html show=true badge=true %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Dropdown with checkboxes - -Use dropdowns with checkboxes to allow users to select options from a predefined list. Dropdowns with checkboxes are particularly useful for filtering. - -{% capture code %} -{% include ui/dropdown-menu.html show=true check=true %} -{% endcapture %} -{% include example.html code=code centered=true %} - -{% capture code %} -{% include ui/dropdown-menu.html show=true radio=true %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Dark dropdown - -Make your dropdown suit the dark mode of your website or software. - -{% capture code %} -{% include ui/dropdown-menu.html show=true dark=true header=true icons=true arrow=true %} -{% endcapture %} -{% include example.html code=code centered=true %} - - -## Dropdown with card content - -Use a dropdown with card content to make it easy for users to get more information on a given subject and avoid ovewhelming them with too much content at once. - -{% capture code %} -{% include ui/button.html text="Button" %} - -{% endcapture %} -{% include example.html code=code centered=true wrapper="btn-list align-items-start" %} \ No newline at end of file diff --git a/src/pages/_docs/dropzone.md b/src/pages/_docs/dropzone.md deleted file mode 100644 index 6d8d5416d..000000000 --- a/src/pages/_docs/dropzone.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Dropzone -menu: help.docs.plugins.dropzone -libs: dropzone -description: Dropzone is a simple JavaScript library that helps you add file drag and drop functionality to your web forms. It is one of the most popular drag and drop library on the web and is used by millions of people. ---- - -## Default Dropzone - -{% capture code %} -{% include ui/dropzone.html id="default" %} -{% endcapture %} -{% include example.html code=code %} - -## Add multiple files - -{% capture code %} -{% include ui/dropzone.html id="mulitple" multiple=true %} -{% endcapture %} -{% include example.html code=code %} - -## Custom Dropzone - -{% capture code %} -{% include ui/dropzone.html id="custom" custom="true" text='Your text here' description="Your custom description here"%} -{% endcapture %} -{% include example.html code=code %} \ No newline at end of file diff --git a/src/pages/_docs/empty.md b/src/pages/_docs/empty.md deleted file mode 100644 index f66374129..000000000 --- a/src/pages/_docs/empty.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Empty states -description: Empty states or blank pages are commonly used as placeholders for first-use, empty data or error screens. Their aim is to engage users when there is no content to display and that is why their design is extremely important from the point of view of the user experience of your website or app. -menu: help.docs.components.empty ---- - - -## Default markup - -Use the default empty state to engage users in the critical moments of their experience with your website or app. A good empty state screen should let users know what is happening and what they should do next as well as encourage them to take action. - -{% capture code %} -{% include ui/empty.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Empty state with illustration - -Make your empty state screen more attractive and engaging by adding an illustration. Thanks to a more personalized design, you will improve your brand image and make your website or app more user friendly. - -{% capture code %} -{% include ui/empty.html illustration=true title="Invoices are managed from here" description="You can see which ones are sent, viewed, partially or fully paid." button-icon="plus" button-text="New invoice" %} -{% endcapture %} -{% include example.html code=code %} - -## Empty state with header - -Instead of adding an icon or illustration you can simply give the text: - -{% capture code %} -{% include ui/empty.html icon-text="404" title="Oops… You just found an error page" description="We are sorry but the page you are looking for was not found" button-text="Take me home" button-icon="arrow-left" %} -{% endcapture %} -{% include example.html code=code %} diff --git a/src/pages/_docs/flags.md b/src/pages/_docs/flags.md deleted file mode 100644 index 5b578deae..000000000 --- a/src/pages/_docs/flags.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Flags -menu: help.docs.plugins.flags -description: Thanks to the Tabler flags plug-in, you can create flags to visually represent countries or languages. Flags are often used in forms, as an element of a delivery address, phone number dialling code and many more. -plugin: flags -libs: tabler-flags ---- - - -## Flag - -To create a flag, add the `flag` class to a component and choose the country whose flag you want to use. The full list of countries can be found below. - -{% capture code %} -{% include ui/flag.html flag="tg" class="me-1" %} -{% include ui/flag.html flag="br" class="me-1" %} -{% include ui/flag.html flag="pt" %} -{% endcapture %} -{% include example.html code=code %} - - -## Flag sizes - -Using Bootstrap’s typical naming structure, you can create a standard flag, or scale it up or down to different sizes based on what’s needed. - -{% capture code %} -{% include ui/flag.html flag="pl" size="xl" class="me-1" %} -{% include ui/flag.html flag="pl" size="lg" class="me-1" %} -{% include ui/flag.html flag="pl" size="md" %} -{% include ui/flag.html flag="pl" size="sm" class="me-1" %} -{% include ui/flag.html flag="pl" size="xs" class="me-1" %} -{% endcapture %} -{% include example.html code=code %} - - -## Types - -To use the flag of a particular country, add the `flag-country-(country name)` class. For example, to create a flag of Andorra should use the following class: `.flag-country-ad`. - - -{% for flag in site.data.flags %} - - - - - -{% endfor %} -
{% include ui/flag.html flag=flag.flag %}{{ flag.flag }}{{ flag.name }}
diff --git a/src/pages/_docs/form-color-check.md b/src/pages/_docs/form-color-check.md deleted file mode 100644 index ee7b7dc69..000000000 --- a/src/pages/_docs/form-color-check.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Color check -menu: help.docs.forms.color-check ---- - -Your input controls can come in a variety of colors, depending on your preferences. Click [here]({% docs_url colors %}) to see the list of available colors. - -{% capture code %} -{% include parts/form/input-color.html %} -{% endcapture %} -{% include example.html code=code %} - -{% capture code %} -{% include parts/form/input-color.html name="color-rounded" rounded=true %} -{% endcapture %} -{% include example.html code=code %} - - -## Input color picker - -Add an color picker to your form to let users customise it according to their preferences. - -{% capture code %} -{% include parts/form/input-colorpicker.html %} -{% endcapture %} -{% include example.html code=code %} - diff --git a/src/pages/_docs/form-elements.md b/src/pages/_docs/form-elements.md deleted file mode 100644 index 752b3a71d..000000000 --- a/src/pages/_docs/form-elements.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -title: Form elements -description: Forms are one of the most important types of interaction with a website or app. Since their aim is to enable users to make a purchase, subscribe to a service or sign up to create an account, it's important to make sure they are easy to complete and help increase conversion rates. Use the available elements to create forms which are well-structured and user-friendly. -bootstrap-link: components/forms/ -libs: nouislider -menu: help.docs.forms.form-elements ---- - - -## Classic inputs - -Use classic, user-friendly inputs, label them appropriately and include input placeholders that will help users avoid confusion when completing a form. - -{% capture code %} -{% include parts/form/input.html type="text" hint="Here's some more info." %} -{% include parts/form/input.html type="password" hint="Here's some more info." %} -{% endcapture %} -{% include example.html code=code %} - - -## Form control rounded - -Use the ``form-control-rounded`` class if you prefer form controls with rounded corners. - -{% capture code %} -
- - - {% include ui/form/input-icon.html input-class="form-control-rounded" %} -
-{% endcapture %} -{% include example.html code=code %} - - -## Form control flush - -You can remove borders from your form control by adding the ``form-control-flush`` class. - -{% capture code %} -
- - -
-{% endcapture %} -{% include example.html code=code %} - - -## Input with icon - -Add icons to your input controls to suggest users what they should enter or inform them of the current state of a form element. - -{% capture code %} -{% include parts/form/input-icon.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Separated inputs - -Include an additional element in your input section, such as a button which can be used to submit the information enetered in the input control. - -{% capture code %} -{% include parts/form/input-icon-separated.html %} -{% endcapture %} -{% include example.html code=code %} - -## Textarea and select - -Use a multi-line text input control to enable users to enter longer pieces of text. The control will automatically adjust to the length of the text entered. - -Add one of the available selects - either a dropdown or a multiple choice select - to let users choose from a predefined set of options. - -{% capture code %} -{% include parts/form/input.html type="textarea" %} - -{% include parts/form/select.html %} -{% include parts/form/select.html label="Select multiple" multiple=true %} -{% endcapture %} -{% include example.html code=code %} - - -## Input size - -Choose the size of an input control that will go well with your form design. Apart from the default size, you can also use small and large input controls. - -{% capture code %} -{% include parts/form/input-sizes.html %} -{% endcapture %} -{% include example.html code=code %} - - - -## Datalists - -Use the ``datalist`` element to add an autocomplete feature to your input control. The list of available options will display once a user starts to type and will make it quicker to complete form sections. - -{% capture code %} -{% include parts/form/input-datalist.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Toggle switches - -Use toggle switches for the elements of your form which require choosing between two opposing states. - -{% capture code %} -{% include parts/form/input-toggle.html %} -{% include parts/form/input-toggle-single.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Radios - -Use radio buttons for the parts of your form which require users to choose one option from a set of two or more mutually exclusive options. - -{% capture code %} -{% include parts/form/input-radios.html %} -{% include parts/form/input-radios-inline.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Checkboxes - -Use checkoxes if you want to allow users to select more than one option from a set of predefined options or to turn an option on or off. - -{% capture code %} -{% include parts/form/input-checkboxes.html %} -{% include parts/form/input-checkboxes-inline.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Range input - -Add a range slider to make it possible for users to set a value or range, such as a price range or a time frame. - -{% capture code %} -{% include parts/form/input-range.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Input group - -Create a group of input controls and place add-ons on either side of an input. - -{% capture code %} -
- - {% include ui/form/input-group.html prepend="@" placeholder="username" class="mb-2" %} - {% include ui/form/input-group.html append=".tabler.io" placeholder="subdomain" class="mb-2" %} - {% include ui/form/input-group.html prepend="https://" append=".tabler.io" placeholder="subdomain" %} -
-{% endcapture %} -{% include example.html code=code %} - - -## Input with checkboxes or radios - -Add checkboxes or radio buttons on either side of your input control. - -{% capture code %} -
- - {% include ui/form/input-group.html prepend="checkbox" class="mb-2" %} - {% include ui/form/input-group.html append="radio" %} -
-{% endcapture %} -{% include example.html code=code %} - -## Input with prepended or appended text - -Add text to your input control, either before or after the text which is to be entered by a user. - -{% capture code %} -
- - {% include ui/form/input-group.html prepend="https://tabler.io/users/" flat=true input-class="ps-0" value="yourfancyusername" class="mb-2" %} - {% include ui/form/input-group.html append=".tabler.io" input-class="text-end pe-0" flat=true value="yourfancydomain" %} -
-{% endcapture %} -{% include example.html code=code %} - -## Input with appended link - -Include a link in your input control to add a clickable element within the control. - -{% capture code %} -
- - {% include ui/form/input-group.html append-link="Show password" flat=true type="password" value="ultrastrongpassword" %} -
-{% endcapture %} -{% include example.html code=code %} - -## Input with appended `` - -Include a `` in your input control to add shortcut to the control. - -{% capture html %} -ctrl + K -{% endcapture %} -{% capture code %} -
- - {% include ui/form/input-group.html append-html=html flat=true type="password" value="ultrastrongpassword" %} -
-{% endcapture %} -{% include example.html code=code %} - - -## Input with appended icon links - -Add an icon link which you want to display at the end of your input control to visually represent actions which a user can take. - -{% capture code %} -
- - {% include ui/form/input-group.html append-button="x:Clear search,adjustments:Search settings,bell:Add notification" flat=true %} -
-{% endcapture %} -{% include example.html code=code %} \ No newline at end of file diff --git a/src/pages/_docs/form-fieldset.md b/src/pages/_docs/form-fieldset.md deleted file mode 100644 index cfc311b9e..000000000 --- a/src/pages/_docs/form-fieldset.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Form fieldset -menu: help.docs.forms.fieldset ---- - -Group parts of your form to make it well-structured and clearer for users, using the ``fieldset`` element. - -{% capture code %} -{% include parts/form/fieldset.html %} -{% endcapture %} -{% include example.html code=code %} \ No newline at end of file diff --git a/src/pages/_docs/form-image-check.md b/src/pages/_docs/form-image-check.md deleted file mode 100644 index f26c07f1b..000000000 --- a/src/pages/_docs/form-image-check.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Image check -menu: help.docs.forms.image-check ---- - -Add an image check to your form and give users visually attractive options to choose from. - -{% capture code %} -{% include parts/form/input-image.html %} -{% endcapture %} -{% include example.html code=code max-width="25rem" %} - -{% capture code %} -{% include parts/form/input-image-radio.html offset=10 %} -{% endcapture %} -{% include example.html code=code max-width="25rem" %} - - -{% capture code %} -{% include parts/form/input-image-people.html %} -{% endcapture %} -{% include example.html code=code %} diff --git a/src/pages/_docs/form-selectboxes.md b/src/pages/_docs/form-selectboxes.md deleted file mode 100644 index e65d45dd5..000000000 --- a/src/pages/_docs/form-selectboxes.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Form selectboxes -menu: help.docs.forms.selectboxes ---- - -Add selectboxes to make your form more intuitive by providing users with a set of options to choose from. You can add simple selectboxes with a label, use icons only or icons with labels. Alternatively, you can use pill selectboxes if they go well with your design. - -{% capture code %} -{% include parts/form/input-selectgroups.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Advanced selectboxes - -Use more advanced selectboxes to display the range of available options. You can choose selectboxes with radio buttons, if you want users to select only one option or with checkboxes, if they are allowed to choose multiple options. - -{% capture code %} -{% include parts/form/selectgroup-payments.html %} -{% include parts/form/selectgroup-project-manager.html %} -{% endcapture %} -{% include example.html code=code %} - diff --git a/src/pages/_docs/form-validation.md b/src/pages/_docs/form-validation.md deleted file mode 100644 index c022d893a..000000000 --- a/src/pages/_docs/form-validation.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Validation states -menu: help.docs.forms.validation-states -description: To inform users whether the entered value is correct or not, use either of the validation states. Thanks to that, users will immediately know which form elements they need to correct and, if the state displays as invalid, why the value is incorrect. ---- - -{% capture code %} -{% include parts/form/validation-states.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Subtle validation states - -If you prefer a more subtle manner of informing users of the input control validation state, you can use tick and cross symbols and resign from colored control frames and the validation feedback. - -{% capture code %} -{% include parts/form/validation-states.html lite=true %} -{% endcapture %} -{% include example.html code=code %} \ No newline at end of file diff --git a/src/pages/_docs/icons.md b/src/pages/_docs/icons.md deleted file mode 100644 index a36a60c38..000000000 --- a/src/pages/_docs/icons.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Icons -menu: help.docs.content.icons -description: Use one of over 1500 icons created specifically for Tabler and make your dashboard look even more attractive. All icons are under MIT license, so you can use them without any problem both in private and commercial projects. -banner: icons ---- - -## Base icon - -{% capture code %} - {% include ui/icon.html icon="heart" %} - {% include ui/icon.html icon="ghost" %} - {% include ui/icon.html icon="star" %} - {% include ui/icon.html icon="bike" %} -{% endcapture %} -{% include example.html code=code %} - -## Filled icons - -{% capture code %} - {% include ui/icon.html icon="heart" class="icon-filled" %} - {% include ui/icon.html icon="circle" class="icon-filled" %} - {% include ui/icon.html icon="star" class="icon-filled" %} - {% include ui/icon.html icon="square" class="icon-filled" %} -{% endcapture %} -{% include example.html code=code %} - -## Icon colors - -{% capture code %} - - {% include ui/icon.html icon="heart" class="icon-filled" %} - - - {% include ui/icon.html icon="star" class="icon-filled" %} - - - {% include ui/icon.html icon="circle" %} - - - {% include ui/icon.html icon="square" %} - -{% endcapture %} -{% include example.html code=code %} - -## Icon animations - -{% capture code %} - {% include ui/icon.html icon="heart" class="icon-pulse" %} - {% include ui/icon.html icon="bell" class="icon-tada" %} - {% include ui/icon.html icon="rotate-clockwise" class="icon-rotate" %} -{% endcapture %} -{% include example.html code=code %} \ No newline at end of file diff --git a/src/pages/_docs/index.html b/src/pages/_docs/index.html deleted file mode 100644 index 787c833d9..000000000 --- a/src/pages/_docs/index.html +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Introduction -menu: help.docs.index -redirect_from: docs.html ---- - -

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 customizable 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!

- -
-
- {% for doc in site.data.docs %} - {% unless doc[1].hide-in-index %} -
-

{{ doc[1].title }}

- - -
- {% endunless %} - {% endfor %} -
-
diff --git a/src/pages/_docs/inline-player.md b/src/pages/_docs/inline-player.md deleted file mode 100644 index 7e48a4d8f..000000000 --- a/src/pages/_docs/inline-player.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Inline player -menu: help.docs.plugins.plyr -libs: plyr -description: A simple, lightweight, accessible and customizable HTML5, YouTube and Vimeo media player that supports modern browsers. ---- - -## Sample demo - -{% capture code %} -{% include ui/inline-player.html id="youtube" embed-id="dQw4w9WgXcQ" %} -{% endcapture %} -{% include example.html code=code %} - - -## Vimeo file - -{% capture code %} -{% include ui/inline-player.html id="vimeo" type="vimeo" embed-id="515937365" %} -{% endcapture %} -{% include example.html code=code %} \ No newline at end of file diff --git a/src/pages/_docs/modals.md b/src/pages/_docs/modals.md deleted file mode 100644 index 58a1a0628..000000000 --- a/src/pages/_docs/modals.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Modals -description: Use Bootstrap’s JavaScript modal plugin to add dialogs to your site for lightboxes, user notifications, or completely custom content. -menu: help.docs.components.modals ---- - -## Default markup - -{% capture code %} -
- -
-{% endcapture %} -{% include example.html code=code modal=true %} - - -## Prompt and alert - -{% capture code %} -
- -
-{% endcapture %} -{% include example.html code=code modal=true %} - -{% capture code %} -
- -
-{% endcapture %} -{% include example.html code=code modal=true %} - - -## Modal with form - -{% capture code %} -
- -
-{% endcapture %} -{% include example.html code=code modal=true %} diff --git a/src/pages/_docs/page-headers.md b/src/pages/_docs/page-headers.md deleted file mode 100644 index 5a322dd14..000000000 --- a/src/pages/_docs/page-headers.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Page headers -menu: help.docs.layout.headers -description: Page heading examples for Tabler ---- - -## Simple header - -{% capture code %} -{% include layout/headers/page-header-5.html %} -{% endcapture %} -{% include example.html code=code columns=2 %} - -## With meta, avatar and actions - -{% capture code %} -{% include layout/headers/page-header-1.html %} -{% endcapture %} -{% include example.html code=code columns=2 %} - -## With meta, search and actions - -{% capture code %} -{% include layout/headers/page-header-2.html %} -{% endcapture %} -{% include example.html code=code columns=2 %} - -## Bordered header - -{% capture code %} -{% include layout/headers/page-header-3.html %} -{% endcapture %} -{% include example.html code=code columns=2 %} - -## Header with breadcrumb and actions - -{% capture code %} -{% include layout/headers/page-header-4.html %} -{% endcapture %} -{% include example.html code=code columns=2 %} diff --git a/src/pages/_docs/payments.md b/src/pages/_docs/payments.md deleted file mode 100644 index d0d580e19..000000000 --- a/src/pages/_docs/payments.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Payments -menu: help.docs.plugins.payments -description: The Tabler payments plug-in will let you use a set of payment provider icons to facilitate the payment process and make it more-user friendly. -plugin: payments ---- - -## Payment - -To create a payment provider icon, add the `payment` class to a component and specify the payment provider. The full list of payment providers can be found below. - -{% capture code %} -{% include ui/payment.html class="me-3" payment="shopify"%} -{% include ui/payment.html class="me-3" payment="visa" %} -{% include ui/payment.html class="me-3" payment="paypal"%} -{% endcapture %} -{% include example.html code=code %} - - -## Payment sizes - -Using Bootstrap’s typical naming structure, you can create a standard payment, or scale it up or down to different sizes based on what’s needed. - -{% capture code %} -{% include ui/payment.html class="me-3" payment="shopify" size="xl" %} -{% include ui/payment.html class="me-3" payment="visa" size="lg" %} -{% include ui/payment.html class="me-3" payment="paypal" size="md" %} -{% include ui/payment.html class="me-3" payment="amazon" size="sm" %} -{% endcapture %} -{% include example.html code=code %} - - -## Types - -Select an icon from the list of payment providers. Each icon comes in two color variants - light and dark, so you can choose the one that goes well with your design. - - -{% for payment in site.data.payments %} - - - - - - -{% endfor %} -
{{ payment.name }}{{ payment.logo }}{% include ui/payment.html payment=payment.logo %}{% include ui/payment.html payment=payment.logo dark=true %}
diff --git a/src/pages/_docs/placeholder.md b/src/pages/_docs/placeholder.md deleted file mode 100644 index a5433efa4..000000000 --- a/src/pages/_docs/placeholder.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -title: Placeholder -menu: help.docs.components.placeholder -description: Placeholder is used to reserve space for content that soon will appear in a layout. -redirect_from: - - /docs/skeleton.html ---- - -## Placeholder line - -Placeholder lines can contain have lines of text. Their length is different and depends on the `col-` class. - -{% capture code %} -
-
-
-
-{% endcapture %} -{% include example.html code=code %} - -However, it may be useful, however, to specify the full width in order to fit the content more effectively. - -{% capture code %} -
-
-
-
-{% endcapture %} -{% include example.html code=code %} - -You can also move the lines to right or to center: - -{% capture code %} -
-
-
-
-
-
-
-
-
-
-{% endcapture %} -{% include example.html code=code %} - - -## Placeholder heading - -A placeholder can contain also a header element looks like header: - -{% capture code %} -
-
-
-{% endcapture %} -{% include example.html code=code %} - -## Placeholder avatar - -You can make your placeholder item look like an avatar. - -{% capture code %} -
-
-
-
-
-
-
-
-
-{% endcapture %} -{% include example.html code=code %} - -The size of avatars is exactly the same as a regular avatar. - -{% capture code %} -
-
-
-
-
-
-{% endcapture %} -{% include example.html code=code %} - -## Placeholder image - -You can use a placeholder, which will look like a picture. You can use the `ratio` component, and get the image in the right proportions. - - -You can also use the `ratio` component, and get the image in the right proportions. - -{% capture code %} -
-
-
-
-
-
-
-
-
-
-
-
-{% endcapture %} -{% include example.html code=code max-width="200px" wrapper="space-y" %} - -## Placeholder color - -By default, the `placeholder` uses `currentColor`. This can be overridden with a custom color or utility class. - -{% capture code %} - - - - - - - - - - -{% endcapture %} -{% include example.html code=code wrapper="space-y" %} - -## Placeholder sizing - -The size of `.placeholders` are based on the typographic style of the parent element. Customize them with sizing modifiers: `.placeholder-lg`, `.placeholder-sm`, or `.placeholder-xs`. - -{% capture code %} - - - - -{% endcapture %} -{% include example.html code=code wrapper="space-y" %} - -## Animation - -Animate placeholders with `.placeholder-glow` or `.placeholder-wave` to better convey the perception of something being actively loaded. - -{% capture code %} -

- -

-

- -

-{% endcapture %} -{% include example.html code=code wrapper="space-y" %} - -## Live examples - -See in the following examples how else you can use the placeholder component - -{% capture code %} -{% include cards/placeholder/card-1.html %} -{% include cards/placeholder/card-2.html %} -{% include cards/placeholder/card-3.html %} -{% include cards/placeholder/card-4.html %} -{% include cards/placeholder/card-6.html %} -{% endcapture %} -{% include example.html code=code columns=1 wrapper="space-y" %} \ No newline at end of file diff --git a/src/pages/_docs/progress.md b/src/pages/_docs/progress.md deleted file mode 100644 index adbda2c77..000000000 --- a/src/pages/_docs/progress.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Progress bars -description: Progress bars are used to provide feedback on an action status and inform users of the current progress. Although seemingly small interface elements, they are extremely hepful in managing users' expectations and preventing them from abandoning a process they have initiated. -bootstrap-link: components/progress -menu: help.docs.components.progress ---- - - -## Default markup - -To create a default progress bar, add a `.progress` class to a `
` element. Thanks to that, you will be able to notify users how long they have to wait for a process to complete. - -{% capture code %} -{% include ui/progress.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Progress size - -Using Bootstrap’s typical naming structure, you can create a standard progress bar or scale it up or down to different sizes based on what’s needed. - -{% capture code %} -{% include ui/progress.html value=57 size="sm" %} -{% endcapture %} -{% include example.html code=code %} - - -## Progress without value - -Remove the displayed value by adding the `.visually-hidden` class. - -{% capture code %} -{% include ui/progress.html value=75 show-value=false %} -{% endcapture %} -{% include example.html code=code %} - - -## Indeterminate progress - -You can create a progress bar which shows indeterminate progress by adding `.progress-bar-indeterminate` to the `.progress-bar` element. - -{% capture code %} -{% include ui/progress.html indeterminate=true size="sm" %} -{% endcapture %} -{% include example.html code=code %} - - -## Native progress element - -You can also use native HTML5 `` element. - -{% capture code %} - -{% endcapture %} -{% include example.html code=code %} - - -## Progress color - -Customize the color of the progress bar to suit your design. Click [here]({% docs_url colors %}) to see the list of available colors. - -{% capture code %} -{% include ui/progress.html size="sm" color="red" class="mb-2" value=24 %} -{% include ui/progress.html size="sm" color="green" class="mb-2" value=45 %} -{% include ui/progress.html size="sm" color="purple" class="mb-2" value=64 %} -{% include ui/progress.html size="sm" color="pink" %} -{% endcapture %} -{% include example.html code=code %} diff --git a/src/pages/_docs/progressbg.md b/src/pages/_docs/progressbg.md deleted file mode 100644 index 9c315b364..000000000 --- a/src/pages/_docs/progressbg.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Progressbg -menu: help.docs.components.progressbg ---- - -{% capture code %} -
- {% include ui/progress.html value=35 class="progressbg-progress" color="primary-lt" %} -
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Ea eos ullam ut. Doloribus est in laborum, ratione recusandae reprehenderit tenetur. Accusantium consectetur ea enim facere ipsam praesentium quas soluta tenetur?
-
35%
-
-{% endcapture %} -{% include example.html code=code %} \ No newline at end of file diff --git a/src/pages/_docs/range-slider.md b/src/pages/_docs/range-slider.md deleted file mode 100644 index 659f273ce..000000000 --- a/src/pages/_docs/range-slider.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: Range slider -menu: help.docs.components.range-slider -libs: nouislider ---- - -To be able to use the range slider in your application you will need to install the nouislider dependency with `npm install nouislider`. - -All options and features can be found [**here**](https://refreshless.com/nouislider/). - - -## Basic range slider - -{% capture code %} -
-

-{% endcapture %} -{% include example.html code=code %} - - -## 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.** -```js -/* Example */ - -window.onload = slider; - -function slider(){ - let sliderText = document.getElementById('sliderText'); - slider1.on('update',function(values,handle){ - sliderText.innerHTML = values[handle]; - }); -} -``` - -{% capture code %} -
-

-{% endcapture %} -{% include example.html code=code %} - - -## start - -The `start` option sets the number of handles and corresponding start positions. - -The `start` option uses the slider's `'format'` option to decode the input. Number input will be cast to string and decoded. - -{% capture code %} -
-

-
-

-
-

-{% 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.** - -{% capture code %} -
-

-
-

-
-

-{% 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. - -{% capture code %} -
-

-
-

-
-

-{% 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. - -If you are using one handle, set the value to either `'upper'` or `'lower'`. -For sliders with 2 or more handles, pass an array with a boolean for every connecting element, including the edges of the slider. The length of this array must match the handle count + 1. - -Setting true sets the bars between the handles, but not between the handles and the sliders edges. - -{% capture code %} -
-

-
-

-
-

-{% 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. - -{% capture code %} -
-

-
-

-{% 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. - -{% capture code %} -
-

-{% endcapture %} -{% include example.html code=code %} - - -## padding - -Padding limits how close to the slider edges handles can be. - -{% capture code %} -
-

-{% endcapture %} -{% include example.html code=code %} - -That's only the basic features and options of range slider. More possibilities can be found [**here**](https://refreshless.com/nouislider/). \ No newline at end of file diff --git a/src/pages/_docs/ribbons.md b/src/pages/_docs/ribbons.md deleted file mode 100644 index 827c08348..000000000 --- a/src/pages/_docs/ribbons.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Ribbons -menu: help.docs.components.ribbons -description: Ribbons are graphical elements which attract users' attention to a given element of an interface and make it stand out. ---- - - -## Default markup - -Use the `ribbon` class to add the default ribbon to any section of your interface. - -{% capture code %} -{% include cards/ribbon.html %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Ribbon position - -You can change the position of a ribbon by adding one of the following classes to the element: - -- `ribbon-top` - moves it to the top -- `ribbon-end` - moves it to the right -- `ribbon-bottom` - moves it to the bottom -- `ribbon-start` - moves it to the left - -Using multiple classes at once will give you more position options. For example, the following class: `.ribbon.ribbon-top.ribbon-left` will move the ribbon to the top left corner. - -{% capture code %} -{% include cards/ribbon.html top=true left=true %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Ribbon color - -Customize the ribbon's background color. You can click [here]({% docs_url colors %}) to see the list of available colors. - -{% capture code %} -{% include cards/ribbon.html color="red" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Ribbon text - -Add your own text to a ribbon to display any additional information and make it easy to spot for users. - -{% capture code %} -{% include cards/ribbon.html color="green" text="-50%" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Ribbon style - -Change the style of a ribbon to make it go well with your interface design. - -{% capture code %} -{% include cards/ribbon.html bookmark=true color="orange" text="-50%" %} -{% endcapture %} -{% include example.html code=code columns=1 %} diff --git a/src/pages/_docs/spinners.md b/src/pages/_docs/spinners.md deleted file mode 100644 index e27bc2d81..000000000 --- a/src/pages/_docs/spinners.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Spinners -menu: help.docs.components.spinners -description: Spinners are used to show the loading state of a component or page. They provide feedback for an action a user has taken, when it takes a bit longer to complete. -bootstrap-link: components/spinners/ ---- - - -## Default markup - -Use the default spinner to notify users that an action they have taken is in progress, helping them avoid confusion. - -{% capture code %} -{% include ui/spinner.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Colors - -Choose one of the available colors to customize the spinner and make it suit your design. - -{% capture code %} -{% for color in site.colors %} -{% assign c = color[0] %} -{% include ui/spinner.html color=c %} -{% endfor %} -{% endcapture %} -{% include example.html code=code %} - - -## Size - -Choose the size of your spinner. You can use the default size or use the `spinner-border-sm` class to display a smaller spinner. - -{% capture code %} -{% include ui/spinner.html %} -{% include ui/spinner.html size="sm" %} -{% endcapture %} -{% include example.html code=code %} - - -## Growing spinner - -Use the growing spinner, if you are looking for a more original design than a border spinner. The spinner grows to show the loading state. - -{% capture code %} -{% include ui/spinner.html type="grow" %} -{% endcapture %} -{% include example.html code=code %} - -Growing spinners also come in a variety of colors to choose from. - -{% capture code %} -{% for color in site.colors %} -{% assign c = color[0] %} -{% include ui/spinner.html color=c type="grow" %} -{% endfor %} -{% endcapture %} -{% include example.html code=code %} - - -### Button with spinner - -Use buttons with spinners to notify users that an action they have taken by clicking the button is in progress and prevent them from clicking multiple times or giving up. - -{% capture code %} -{% include ui/button.html spinner=true text="Button" color="primary" %} -{% include ui/button.html spinner=true text="Button" color="danger" %} -{% include ui/button.html spinner=true text="Button" color="warning" %} -{% include ui/button.html spinner=true text="Button" color="success" %} -{% include ui/button.html spinner=true text="Button" %} -{% endcapture %} -{% include example.html code=code %} - -## Animated dots - -{% capture code %} -

Loading

-{% endcapture %} -{% include example.html code=code wrapper="text-center" %} - -{% capture code %} -{% include ui/button.html dots=true text='Loading' color="primary" %} -{% include ui/button.html dots=true text='Loading' disabled=true color="primary" %} -{% endcapture %} -{% include example.html code=code %} \ No newline at end of file diff --git a/src/pages/_docs/statuses.md b/src/pages/_docs/statuses.md deleted file mode 100644 index fe40cf3c3..000000000 --- a/src/pages/_docs/statuses.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: Statuses -menu: help.docs.components.statuses -description: Status dots are particularly useful if you want to make an interface element more noticeable regardless of limited space. ---- - -## Default markup - -{% capture code %} -{% for color in site.colors %} -{% assign c = color[0] %} -{% assign t = color[1].title %} -{% include ui/status.html color=c text=t %} -{% endfor %} -{% endcapture %} -{% include example.html code=code centered=true wrapper="btn-list" %} - -## Status with dot - -{% capture code %} -{% for color in site.colors %} -{% assign c = color[0] %} -{% assign t = color[1].title %} -{% include ui/status.html color=c text=t dot=true %} -{% endfor %} -{% endcapture %} -{% include example.html code=code centered=true wrapper="btn-list" %} - -### Animated dot - -{% capture code %} -{% for color in site.colors %} -{% assign c = color[0] %} -{% assign t = color[1].title %} -{% include ui/status.html color=c text=t dot=true animated=true %} -{% endfor %} -{% endcapture %} -{% include example.html code=code centered=true wrapper="btn-list" %} - -## Lite status - -{% capture code %} -{% for color in site.colors %} -{% assign c = color[0] %} -{% assign t = color[1].title %} -{% include ui/status.html color=c text=t dot=true lite=true %} -{% endfor %} -{% endcapture %} -{% include example.html code=code centered=true wrapper="btn-list" %} - -## Status dots - -{% capture code %} -{% for color in site.colors %} - -{% endfor %} -{% endcapture %} -{% include example.html code=code centered=true wrapper="btn-list" %} - -### Animated dots - -{% capture code %} -{% for color in site.colors %} - -{% endfor %} -{% endcapture %} -{% include example.html code=code centered=true wrapper="btn-list" %} - -## Status indicator - -{% capture code %} -{% for color in site.colors %} -{% assign c = color[0] %} -{% include ui/status-indicator.html animated=true color=c %} -{% endfor %} -{% endcapture %} -{% include example.html code=code centered=true wrapper="btn-list" %} \ No newline at end of file diff --git a/src/pages/_docs/steps.md b/src/pages/_docs/steps.md deleted file mode 100644 index f8f536fe6..000000000 --- a/src/pages/_docs/steps.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Steps -menu: help.docs.components.steps -description: Steps are used to guide users through complex processes, making them easier and more intuitive. Breaking a multi-step process into smaller parts and tracking progress along the way helps users complete it successfully. -new: true ---- - - -## Default markup - -Steps show users where they are within a process, what steps they have already completed and what they are expected to complete. Making multi-step processes more user-friendly facilitates users' interaction with your interface. - -Use the `steps` class to create the default progress tracker and name the steps accordingly. - -{% capture code %} -{% include ui/steps.html show-title=true %} -{% endcapture %} -{% include example.html code=code %} - - -## Tooltips - -Add tooltips, if you want to provide users with additional information about the steps they are expected to complete. Tooltips are displayed when a user hovers over a given step and help clarify what might not be clear from the interface. - -{% capture code %} -{% include ui/steps.html show-title=true show-tooltip=true %} -{% endcapture %} -{% include example.html code=code %} - - -## Color - -You can customize the default progress indicator by changing the color to one that better suits your design. Click [here]({% docs_url colors %}) to see the range of available colors. - -{% capture code %} -{% include ui/steps.html color="green" show-title=true %} -{% include ui/steps.html color="red" show-title=true %} -{% endcapture %} -{% include example.html code=code %} - - -## Steps without title - -For designs with limited space, use progress indicators without titles and add tooltips to provide the necessary details. - -{% capture code %} -{% include ui/steps.html show-tooltip=true %} -{% endcapture %} -{% include example.html code=code %} - - -## Steps with numbers - -Use the `steps-counter` class to create a progress tracker with numbers instead of titles and change the color to customize it. - -{% capture code %} -{% include ui/steps.html count=5 active=2 numbers=true color="lime" %} -{% endcapture %} -{% include example.html code=code %} diff --git a/src/pages/_docs/switch-icon.md b/src/pages/_docs/switch-icon.md deleted file mode 100644 index 4897113c6..000000000 --- a/src/pages/_docs/switch-icon.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Switch icon -menu: help.docs.components.switch-icon -description: The Switch Icon component is used to create a transition between two icons. You can use any icon, both line and filled version. -banner: icons ---- - -## Default markup - -To replace the icons, all should add `active` class to the `switch-icon` component. - -{% capture code %} -{% include ui/switch-icon.html icon="circle" icon-b="square" icon-b-color="primary" %} -{% endcapture %} -{% include example.html code=code wrapper="d-flex space-x-2" %} - -## Switch animations - -You can also add a fancy animation to add variety to your button. See demo below: - -{% capture code %} -{% include ui/switch-icon.html icon="circle" icon-b-class="icon-filled" icon-b-color="primary" %} -{% include ui/switch-icon.html variant="fade" icon-b-class="icon-filled" %} -{% include ui/switch-icon.html variant="scale" icon="star" icon-b-class="icon-filled" icon-b-color="yellow" %} -{% include ui/switch-icon.html variant="flip" icon="thumb-up" icon-b-color="facebook" %} -{% include ui/switch-icon.html variant="slide-up" icon="brand-twitter" icon-b-color="twitter" %} -{% include ui/switch-icon.html variant="slide-left" icon="check" icon-b="x" icon-b-color="red" %} -{% include ui/switch-icon.html variant="slide-down" icon="arrow-down" icon-b="arrow-up" icon-a-color="muted" icon-b-color="muted" %} -{% include ui/switch-icon.html variant="slide-right" icon="car" icon-b="scooter" icon-b-color="muted" %} -{% endcapture %} -{% include example.html code=code wrapper="d-flex space-x-2" %} \ No newline at end of file diff --git a/src/pages/_docs/tables.md b/src/pages/_docs/tables.md deleted file mode 100644 index 8b3537bd2..000000000 --- a/src/pages/_docs/tables.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: Tables -menu: help.docs.components.tables -description: Tables are a useful interface element that allows to visualise data and arrange it in a clear way. Thanks to that, users can browse a lot of information at once and a good table design will help you take care of its clarity. -bootstrap-link: content/tables/ ---- - - -## Basic Table - -The basic table design has light padding and the presented data is separated wih horizontal dividers. It helps provide users with all the necessary information, without overwheling them with visuals. - -The `.table` class adds basic styling to a table: - -{% capture code %} -{% include ui/table.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Responsive tables - -Use the `.table-responsive` class across each breakpoint for horizontal scrolling tables. If you want to create responsive tables up to a specific breakpoint, use `.table-responsive{-sm|-md|-lg|-xl}`. From that breakpoint and up, the table will behave normally, rather than scroll horizontally. - -{% capture code %} - - - - - {% for i in (1..10) %} - - {% endfor %} - - - - {% for j in (1..2) %} - - - {% for i in (1..10) %} - - {% endfor %} - - {% endfor %} - -
#Heading {{ i }}
{{ j }}Cell
-{% endcapture %} -{% include example.html code=code %} - -## No wrap - -If you don't want the table cell content to wrap to another line, use the `table-nowrap` class. - -{% capture code %} -{% include ui/table.html nowrap=true responsive=true %} -{% endcapture %} -{% include example.html code=code %} - -## Table Variants - -{% capture code %} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ClassHeadingHeading
DefaultCellCell
PrimaryCellCell
SecondaryCellCell
SuccessCellCell
DangerCellCell
WarningCellCell
InfoCellCell
LightCellCell
DarkCellCell
-{% endcapture %} -{% include example.html code=code %} \ No newline at end of file diff --git a/src/pages/_docs/tabs.md b/src/pages/_docs/tabs.md deleted file mode 100644 index a88ba0495..000000000 --- a/src/pages/_docs/tabs.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Tabs -menu: help.docs.components.tabs -description: Tabs allow users to alternate between equally important views within the same context. By dividing content into meaningful sections, they improve its organization and make it easy for users to navigate. -bootstrap-link: components/navs/ ---- - - -## Default markup - -Use tabs to let users access different sections within one context quickly and with ease. In the default design, the current tab is highlighted, which makes the interface clear and user-friendly. - -{% capture code %} -{% include cards/tabs.html id="ex1" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Tabs with icons - -Add icons to your tab labels, if you want to use a visual element and make the tab content easier to identify. - -{% capture code %} -{% include cards/tabs.html icons=true settings=true id="ex2" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Tabs only with icons - -Use tabs without label names to save space and make the tab content easy to recognize for international users. - -{% capture code %} -{% include cards/tabs.html icons=true settings=true hide-text=true id="ex3" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Tabs with dropdown - -Make one or more of your tabs into a dropdown to add more options within one element. - -{% capture code %} -{% include cards/tabs.html dropdown=true id="ex4" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Full-width tabs - -Add the `nav-fill` class to make the tabs take up the full space of the parent element. - -{% capture code %} -{% include cards/tabs.html justified=true icons=true hide-text=true activity=true id="ex5" %} -{% endcapture %} -{% include example.html code=code columns=1 %} - - -## Alternate style - -Use the `nav-tabs-alt` class to make the labels display in capital letters. - -{% capture code %} -{% include cards/tabs.html icons=true alternative=true settings=true id="ex6" %} -{% endcapture %} -{% include example.html code=code columns=1 %} diff --git a/src/pages/_docs/timelines.md b/src/pages/_docs/timelines.md deleted file mode 100644 index 0518ce414..000000000 --- a/src/pages/_docs/timelines.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Timelines -description: A timeline is a perfect way to visualize processes and projects, as it's easy to read and attractive for users. You can use it to give an overview of events, present an agenda or point out important points in time. -menu: help.docs.components.timelines ---- - - -## Timeline - -The available timeline design is comprised of many components that will help you visualize a process or show an outline of events. Thanks to the possibility of adding icons, avatars and links and the way of presenting the elements of content, your timeline will be clear for users and will make yor website or app more attractive. - -{% capture code %} -{% include cards/timeline.html %} -{% endcapture %} -{% include example.html code=code columns=2 %} - - -## Simple timeline - -Use a simplified version of the timeline, if it suits your design better. You can still make use of all the available timeline components. - -{% capture code %} -{% include cards/timeline.html simple=true %} -{% endcapture %} -{% include example.html code=code columns=2 %} diff --git a/src/pages/_docs/tinymce.md b/src/pages/_docs/tinymce.md deleted file mode 100644 index 5a49f6bba..000000000 --- a/src/pages/_docs/tinymce.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: TinyMCE -menu: help.docs.plugins.tinymce -libs: tinymce -description: The WYSIWYG editor that is flexible, customizable, and designed with the user in mind. TinyMCE can handle any challenge, from the most simple implementation through to the most complex use case. ---- - -[TinyMCE](https://www.tiny.cloud/docs/) documentation. - -## Default text editor - -Initialize TinyMCE 6 on any element (or elements) on the web page by passing an object containing a selector value to `tinymce.init()`. The selector value can be any valid CSS selector. - -{% capture code %} -{% include ui/tinymce.html id="default" %} -{% endcapture %} -{% include example.html code=code %} \ No newline at end of file diff --git a/src/pages/_docs/toasts.md b/src/pages/_docs/toasts.md deleted file mode 100644 index 5517b5bd6..000000000 --- a/src/pages/_docs/toasts.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Toasts -menu: help.docs.components.toasts -description: Toasts are lightweight alert boxes which display for a few seconds after a user has taken an action, to inform them of the state or outcome. They can be used when a user clicks a button or submits a form and their aim is to provide feedback, rather than encourage to take action. -bootstrap-link: components/toasts/ ---- - - -## Default markup - -Use the default toast message to inform users of the outcome of their action and provide additional information. It contains an `x` close button to make it possible for users to close the toast if they wish. - -{% capture code %} -{% include ui/toast.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Translucent - -Toasts blend over the elements they appear over. If a browser supports the `backdrop-filter` CSS property, the elements under a toast will be blurred. - -{% capture code %} -{% include ui/toast.html %} -{% endcapture %} -{% include example.html code=code %} - - -## Stacking toasts - -Stack multiple toasts together by putting them within one `.toast-container`. - -{% capture code %} -
- {% include ui/toast.html person-id=3 %} - {% include ui/toast.html date="7 mins ago" text="This is another toast message." %} -
-{% endcapture %} -{% include example.html code=code %} \ No newline at end of file diff --git a/src/pages/_docs/tracking.md b/src/pages/_docs/tracking.md deleted file mode 100644 index 5570739ec..000000000 --- a/src/pages/_docs/tracking.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Tracking -menu: help.docs.components.tracking -description: Component for visualising activity logs or other monitoring-related data. ---- - -{% capture code %} -{% include ui/tracking.html %} -{% endcapture %} -{% include example.html code=code max-width="20rem" centered=true %} - -{% capture code %} -
-
-
-
Status monitoring
-
- {% include parts/dropdown/months.html %} -
-
-
-
99.5%
-
- {% include ui/trending.html value=2 %} -
-
-
- {% include ui/tracking.html %} -
-
-
-{% endcapture %} -{% include example.html code=code columns=1 %} \ No newline at end of file diff --git a/src/pages/_docs/typography.md b/src/pages/_docs/typography.md deleted file mode 100644 index e48a5050a..000000000 --- a/src/pages/_docs/typography.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -title: Typography -menu: help.docs.content.typography -description: Typography plays an important role in creating an attractive and clear interface design. Good typography will make the content easy to follow and improve the usability of your website. -bootstrap-link: content/typography/ ---- - - -## Headings - -Use HTML headings to organize content on your website and make the structure clear and user-friendly. - -{% capture code %} -{% for i in (1..6) %}H{{ i }} Heading -{% endfor %} -{% endcapture %} -{% include example.html code=code %} - - -## Paragraphs - -Organize longer pieces of text into paragraphs using the `p` tag. - -{% capture code %} -

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

-

At vero eos et accusam et justo duo dolores et ea rebum.

-{% endcapture %} -{% include example.html code=code %} - - -## Semantic text elements - -Use a variety of semantic text elements, depending of how you want to display particular fragments of content. - -{% capture code %} -I18N{% hide %} abbr
{% endhide %} -Bold{% hide %} strong b
{% endhide %} -Citation{% hide %} cite
{% endhide %} -Hello World!{% hide %} code
{% endhide %} -Deleted{% hide %} del
{% endhide %} -Emphasis{% hide %} em
{% endhide %} -Italic{% hide %} i
{% endhide %} -Inserted{% hide %} ins
{% endhide %} -Ctrl + S{% hide %} kbd
{% endhide %} -Highlighted{% hide %} mark
{% endhide %} -Strikethrough s
{% endhide %} -Sample{% hide %} samp
{% endhide %} -Text Subscripted{% hide %} sub
{% endhide %} -Text Superscripted{% hide %} sup
{% endhide %} -{% hide %} time
{% endhide %} -Underline{% hide %} u
{% endhide %} -x = y + 2{% hide %} var
{% endhide %} -{% endcapture %} -{% include example.html code=code %} - - -## Horizontal rules - -Use the `hr` tag to represent a thematic break between paragraphs within one section. - -{% capture code %} -
-{% endcapture %} -{% include example.html code=code %} - - -## Horizontal rules with label - -You can also add a label to a horizontal rule and align it as you see fit. - -{% capture code %} -

- Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. -

-
- Rule text -
-

- At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. -

-
- Rule text -
-

- Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. -

-
- Rule text -
-

- At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. -

-{% endcapture %} -{% include example.html code=code %} - - -## Optimized for different alphabets - -Tabler has been optimized to correctly display content in any language. It supports most Asian, African and Middle Eastern languages. - -{% capture code %} -
Chinese
-

汉字

- -
Japanese
-

日本語の表記体系

- -
Korean
-

한글

- -
Cyrillic
-

Кириллица

- -
Greek
-

Eλληνική

- -
Georgian
-

ქართული დამწერლობა

- -
Armenian
-

Հայերենի այբուբեն

- -
Arabic
-

الحروف العربية

- -
Hebrew
-

אלפבית עברי

- -
Thai
-

อักษรไทย

-{% endcapture %} -{% include example.html code=code %} - - -## Text transform - -Transform the content of components with text capitalization classes. - -{% capture code %} -

Lowercased text.

-

Uppercased text.

-

Capitalized text.

-{% endcapture %} -{% include example.html code=code %} - - -## Letter spacing - -Control the tracking (letter spacing) of an element and make it tight, wide or normal. - -{% capture code %} -

Lorem ipsum dolor sit amet. Tight letter spacing.

-

Lorem ipsum dolor sit amet. Normal letter spacing.

-

Lorem ipsum dolor sit amet. Wide letter spacing.

-{% endcapture %} -{% include example.html code=code %} - - -## Line height - -Control the leading (line height) of an element. - -{% capture code %} -

Lorem ipsum dolor sit amet.
Dolor sit amet.

-

Lorem ipsum dolor sit amet.
Dolor sit amet.

-

Lorem ipsum dolor sit amet.
Dolor sit amet.

-

Lorem ipsum dolor sit amet.
Dolor sit amet.

-{% endcapture %} -{% include example.html code=code %} - - -## Antialiasing - -Control the font smoothing of an element. - -Use the `.antialiased` utility to render text using subpixel antialiasing or use the `.subpixel-antialiased` utility to remove antialiasing. - -{% capture code %} -
Text with antialiasing
-
Text without antialiasing
-{% endcapture %} -{% include example.html code=code %} - -## Keyboard input - -Use the `` to indicate input that is typically entered via keyboard. - -{% capture code %} -To edit settings, press ctrl + , or ctrl + C. -{% endcapture %} -{% include example.html code=code %} - - -## Markdown elements - -If you can't use the CSS classes you want or if you just want to use HTML tags, use the `.markdown` class in a container. It can handle almost any HTML tag. - -{% capture code %} -
-

Hello World

-

Lorem ipsum[1] dolor sit amet, consectetur adipiscing elit. Nulla accumsan, metus ultrices eleifend gravida, nulla nunc varius lectus, nec rutrum justo nibh eu lectus. Ut vulputate semper dui. Fusce erat odio, sollicitudin vel erat vel, interdum mattis neque. Subscript works as well!

-

Second level

-

Curabitur accumsan turpis pharetra augue tincidunt blandit. Quisque condimentum maximus mi, sit amet commodo arcu rutrum id. Proin pretium urna vel cursus venenatis. Suspendisse potenti. Etiam mattis sem rhoncus lacus dapibus facilisis. Donec at dignissim dui. Ut et neque nisl.

-
    -
  • In fermentum leo eu lectus mollis, quis dictum mi aliquet.
  • -
  • Morbi eu nulla lobortis, lobortis est in, fringilla felis.
  • -
  • Aliquam nec felis in sapien venenatis viverra fermentum nec lectus.
  • -
  • Ut non enim metus.
  • -
-
-{% endcapture %} -{% include example.html code=code %} diff --git a/src/pages/_includes/layout/footer.html b/src/pages/_includes/layout/footer.html index 32135011f..76915b150 100644 --- a/src/pages/_includes/layout/footer.html +++ b/src/pages/_includes/layout/footer.html @@ -3,7 +3,7 @@
    -
  • Documentation
  • +
  • Documentation
  • License
  • Source code
  • diff --git a/src/pages/_includes/redirect.html b/src/pages/_includes/redirect.html index e4c5479cf..0773512f1 100644 --- a/src/pages/_includes/redirect.html +++ b/src/pages/_includes/redirect.html @@ -1,10 +1,11 @@ +{% capture url %}{% if include.url contains 'http://' or include.url contains 'https://' %}{{ include.url }}{% else %}{{ site.base }}{{ include.url }}{% endif %}{% endcapture %} Redirecting… - - + + - - + + diff --git a/src/pages/docs/index.html b/src/pages/docs/index.html new file mode 100644 index 000000000..f2db513ba --- /dev/null +++ b/src/pages/docs/index.html @@ -0,0 +1,5 @@ +--- +layout: redirect +redirect: + to: https://tabler.io/docs +--- \ No newline at end of file diff --git a/vercel.json b/vercel.json index b27d1ff24..45bedece9 100644 --- a/vercel.json +++ b/vercel.json @@ -12,5 +12,47 @@ "source": "/(.*)", "destination": "/error-404.html" } + ], + "redirects": [ + { + "source": "/docs", + "destination": "https://tabler.io/docs", + "permanent": true + }, + { + "source": "/docs/:name(colors|typography?).html", + "destination": "https://tabler.io/docs/base/:name", + "permanent": true + }, + { + "source": "/docs/:name(alerts|autosize|avatars|badges|breadcrumb|buttons|cards|carousel|charts|countup|datagrid|divider|dropdowns|dropzone|empty|icons|inline-player|modals|placeholder|popover|progress|progressbg|range-slider|ribbons|spinners|statuses|steps|switch-icon|tables|tabs|timelines|tinymce|toasts|tooltips|tracking?).html", + "destination": "https://tabler.io/docs/components/:name", + "permanent": true + }, + { + "source": "/docs/:name(form-color-check|form-elements|form-fieldset|form-helpers|form-image-check|form-input-mask|form-selectboxes|form-validation?).html", + "destination": "https://tabler.io/docs/forms/:name", + "permanent": true + }, + { + "source": "/docs/:name(browser-support|customize|download|faq?).html", + "destination": "https://tabler.io/docs/getting-started/:name", + "permanent": true + }, + { + "source": "/docs/:name(page-headers?).html", + "destination": "https://tabler.io/docs/layout/:name", + "permanent": true + }, + { + "source": "/docs/:name(flags|payments?).html", + "destination": "https://tabler.io/docs/plugins/:name", + "permanent": true + }, + { + "source": "/docs/:name(borders|cursors|interactions?).html", + "destination": "https://tabler.io/docs/plugins/:name", + "permanent": true + } ] } \ No newline at end of file