diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 3a3c44f..6279049 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -18,6 +18,13 @@ function buildSidebar() { collapsible: true, items: [...getFormComponents()], }, + { + text: 'Typography', + collapsible: true, + items: [ + ...getTypography(), + ] + }, { text: 'Utils', collapsible: true, @@ -75,6 +82,15 @@ function getUtils() { ] } +function getTypography() { + return [ + { text: 'Heading', link: '/components/heading' }, + { text: 'Paragraph', link: '/components/paragraph' }, + { text: 'Image', link: '/components/image' }, + { text: 'Link', link: '/components/link' } + ] +} + /** * This can be used as an example * https://github.com/vuejs/vitepress/blob/master/docs/.vitepress/config.js diff --git a/docs/components/heading.md b/docs/components/heading.md new file mode 100644 index 0000000..48ed38e --- /dev/null +++ b/docs/components/heading.md @@ -0,0 +1,142 @@ + + +# Vue Heading - Flowbite + +#### The heading component defines six levels of title elements from H1 to H6 that are used as titles and subtitles on a web page based on multiple styles and layouts + +## Heading one (H1) + +Use the `tag="h1"` as the most important text element to indicate the title of your web page. + +```vue + + + +``` + +

+ +## Heading one (H2) + +The H2 tag can be used as subtitles of the page’s sections. + +```vue + + + +``` + +

+ +## Heading one (H3) + +Use the H3 tags inside sections that already have a H2 available. + +```vue + + + +``` + +

+ +## Heading one (H4) + +The H4 can be generally used after H2 and H3 tags are already present and you need a more in-depth hierarchy. + +```vue + + + +``` + +

+ +## Heading one (H5) + +The H5 tag is most often used in longer articles with other heading already available or in sidebars. + +```vue + + + +``` + +

+ +## Heading one (H6) + +Using the H6 tag is quite rare because it means that you’ve already used all heading from H1 to H5, but you can still use it if you have a very complex article with lots of headings. + +```vue + + + +``` + +
+ +## Color + +Use the `color` prop to set the text color. + +```vue + + + +``` + + + +## Custom classes + +Use the `class` attribute to apply the tailwind classes. + +```vue + + + +``` + + diff --git a/docs/components/image.md b/docs/components/image.md new file mode 100644 index 0000000..35753fa --- /dev/null +++ b/docs/components/image.md @@ -0,0 +1,113 @@ + + +# Vue Images - Flowbite + +#### The image component can be used to embed images inside the web page in articles and sections based on multiple styles, sizes, layouts and hover animations + +## Default image + +Use this example to show the a responsive image that won’t grow beyond the maximum original width. + +```vue + + + +``` + + + +## Image caption + +This example can be used to add a caption for the image often used inside articles. Use `caption-class` to override the cation. + +```vue + + + +``` + + + +## Sizes + +Set the size of the image using the `w-size` and `h-size` or `max-w-size` utility classes from Tailwind CSS to set the width and height of the element. + +```vue + + + +``` + + + +## Alignment + +Align the image component to the center or right side of the document page using `mx-auto` and `ml-auto` margin styles. + +```vue + + + +``` + + + +## Grayscale + +Use the filter option and apply a grayscale to the image element using the grayscale class. + +```vue + + + +``` + + + +## Custom classes + +Use the `img-class` prop to apply tailwind classes. + +```vue + + + +``` + + diff --git a/docs/components/link.md b/docs/components/link.md new file mode 100644 index 0000000..fb4cc01 --- /dev/null +++ b/docs/components/link.md @@ -0,0 +1,60 @@ + + +# Vue Links - Flowbite + +#### The link component can be used to set hyperlinks from one page to another or to an external website when clicking on an inline text item, button, or card + +## Default link + +Use this example to set default styles to an inline link element. + +```vue + + + +``` + + + +## Para link + +Use this example to set a link inside a paragraph with an underline style. + +```vue + + + +``` + + + +## Custom classes + +Use `class` attribute prop to apply the tailwind classes. + +```vue + + + +``` + + diff --git a/docs/components/paragraph.md b/docs/components/paragraph.md new file mode 100644 index 0000000..41019db --- /dev/null +++ b/docs/components/paragraph.md @@ -0,0 +1,86 @@ + + +# Vue Paragraph - Flowbite + +#### Use the paragraph component to create multiple blocks of text separated by blank lines and write content based on multiple layouts and styles + +## Default paragraph + +Use this example of a paragraph element to use inside article content or a landing page. + +```vue + + + +``` + +

+ +## Weight + +Use `weight` prop to set the text-weight. + +```vue + + + +``` + + + +## Alignment + +Use `align` prop to set the text alignment. + +```vue + + + +``` + + + +## Custom classes + +Use `class` attribute to apply the tailwind classes. + +```vue + + + +``` + + diff --git a/docs/components/typography/heading/H1.vue b/docs/components/typography/heading/H1.vue new file mode 100644 index 0000000..ef46945 --- /dev/null +++ b/docs/components/typography/heading/H1.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/heading/H2.vue b/docs/components/typography/heading/H2.vue new file mode 100644 index 0000000..5fe1f9f --- /dev/null +++ b/docs/components/typography/heading/H2.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/heading/H3.vue b/docs/components/typography/heading/H3.vue new file mode 100644 index 0000000..8b62b3f --- /dev/null +++ b/docs/components/typography/heading/H3.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/heading/H4.vue b/docs/components/typography/heading/H4.vue new file mode 100644 index 0000000..a4cd63e --- /dev/null +++ b/docs/components/typography/heading/H4.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/heading/H5.vue b/docs/components/typography/heading/H5.vue new file mode 100644 index 0000000..6eb92e9 --- /dev/null +++ b/docs/components/typography/heading/H5.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/heading/H6.vue b/docs/components/typography/heading/H6.vue new file mode 100644 index 0000000..600da8f --- /dev/null +++ b/docs/components/typography/heading/H6.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/heading/HColor.vue b/docs/components/typography/heading/HColor.vue new file mode 100644 index 0000000..bd20bd7 --- /dev/null +++ b/docs/components/typography/heading/HColor.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/heading/HCustom.vue b/docs/components/typography/heading/HCustom.vue new file mode 100644 index 0000000..cc8fcdc --- /dev/null +++ b/docs/components/typography/heading/HCustom.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/image/Img.vue b/docs/components/typography/image/Img.vue new file mode 100644 index 0000000..442fcea --- /dev/null +++ b/docs/components/typography/image/Img.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/image/ImgAlign.vue b/docs/components/typography/image/ImgAlign.vue new file mode 100644 index 0000000..290fdd8 --- /dev/null +++ b/docs/components/typography/image/ImgAlign.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/image/ImgBlur.vue b/docs/components/typography/image/ImgBlur.vue new file mode 100644 index 0000000..3c666ef --- /dev/null +++ b/docs/components/typography/image/ImgBlur.vue @@ -0,0 +1,13 @@ + + + diff --git a/docs/components/typography/image/ImgCap.vue b/docs/components/typography/image/ImgCap.vue new file mode 100644 index 0000000..c006840 --- /dev/null +++ b/docs/components/typography/image/ImgCap.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/image/ImgCustom.vue b/docs/components/typography/image/ImgCustom.vue new file mode 100644 index 0000000..65c9cc2 --- /dev/null +++ b/docs/components/typography/image/ImgCustom.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/image/ImgSize.vue b/docs/components/typography/image/ImgSize.vue new file mode 100644 index 0000000..0257513 --- /dev/null +++ b/docs/components/typography/image/ImgSize.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/link/A.vue b/docs/components/typography/link/A.vue new file mode 100644 index 0000000..de721ce --- /dev/null +++ b/docs/components/typography/link/A.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/link/ACustom.vue b/docs/components/typography/link/ACustom.vue new file mode 100644 index 0000000..de5fbfc --- /dev/null +++ b/docs/components/typography/link/ACustom.vue @@ -0,0 +1,7 @@ + + + diff --git a/docs/components/typography/link/APara.vue b/docs/components/typography/link/APara.vue new file mode 100644 index 0000000..418e994 --- /dev/null +++ b/docs/components/typography/link/APara.vue @@ -0,0 +1,11 @@ + + + diff --git a/docs/components/typography/p/P.vue b/docs/components/typography/p/P.vue new file mode 100644 index 0000000..c1f0088 --- /dev/null +++ b/docs/components/typography/p/P.vue @@ -0,0 +1,10 @@ + + + diff --git a/docs/components/typography/p/PAlign.vue b/docs/components/typography/p/PAlign.vue new file mode 100644 index 0000000..9689d32 --- /dev/null +++ b/docs/components/typography/p/PAlign.vue @@ -0,0 +1,10 @@ + + + diff --git a/docs/components/typography/p/PCustom.vue b/docs/components/typography/p/PCustom.vue new file mode 100644 index 0000000..5914350 --- /dev/null +++ b/docs/components/typography/p/PCustom.vue @@ -0,0 +1,10 @@ + + + diff --git a/docs/components/typography/p/PWeight.vue b/docs/components/typography/p/PWeight.vue new file mode 100644 index 0000000..36e59cb --- /dev/null +++ b/docs/components/typography/p/PWeight.vue @@ -0,0 +1,10 @@ + + + diff --git a/src/components/Typography/A.vue b/src/components/Typography/A.vue new file mode 100644 index 0000000..3084285 --- /dev/null +++ b/src/components/Typography/A.vue @@ -0,0 +1,17 @@ + + + diff --git a/src/components/Typography/Heading.vue b/src/components/Typography/Heading.vue new file mode 100644 index 0000000..f011e59 --- /dev/null +++ b/src/components/Typography/Heading.vue @@ -0,0 +1,28 @@ + + + diff --git a/src/components/Typography/Img.vue b/src/components/Typography/Img.vue new file mode 100644 index 0000000..a18ccdf --- /dev/null +++ b/src/components/Typography/Img.vue @@ -0,0 +1,34 @@ + + + diff --git a/src/components/Typography/P.vue b/src/components/Typography/P.vue new file mode 100644 index 0000000..81cdf33 --- /dev/null +++ b/src/components/Typography/P.vue @@ -0,0 +1,65 @@ + + + diff --git a/src/index.ts b/src/index.ts index 6e65bbb..828df07 100644 --- a/src/index.ts +++ b/src/index.ts @@ -69,4 +69,9 @@ export { default as Radio } from './components/Radio/Radio.vue' export { default as FileInput } from './components/FileInput/FileInput.vue' +export { default as Heading } from './components/Typography/Heading.vue' +export { default as A } from './components/Typography/Heading.vue' +export { default as P } from './components/Typography/P.vue' +export { default as Img } from './components/Typography/Img.vue' + export * from './composables'