flowbite-svelte 0.44.8 → 0.44.10

package/src/routes/docs/typography/image.md

@@ -0,0 +1,244 @@
+---
+layout: componentLayout
+title: Svelte Images - Flowbite
+breadcrumb_title: Svelte Images
+component_title: Image
+dir: Typography
+description: 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
+thumnailSize: w-64
+---
+
+<script>
+  import { TableProp, TableDefaultRow, CompoAttributesViewer } from '../../utils'
+  import { A, Heading } from '$lib'
+
+  const components = 'Img'
+</script>
+
+Get started with a collection of responsive image components coded with the utility classes from Tailwind CSS that you can use inside articles, cards, sections, and other components based on multiple styles, sizes, layouts, and hover animations.
+
+## Setup
+
+```html
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+```
+
+## Default image
+
+Use this example to show the a responsive image that won’t grow beyond the maximum original width.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/image-1@2x.jpg" alt="sample 1" />
+```
+
+## Image caption
+
+This example can be used to add a caption for the image often used inside articles.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/image-1@2x.jpg" alt="sample 1" caption="Image caption" />
+```
+
+## Rounded corners
+
+Apply rounded corners to the image by using the specific utility classes from Tailwind CSS.
+
+### Border radius
+
+Use this example to apply rounded corners to the image by using the rounded-size class where the size can be anything from small to extra large.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/image-1@2x.jpg" alt="sample 1" size="max-w-lg" class="rounded-lg" />
+```
+
+### Full circle
+
+Use this example to mask the image inside a circle using the rounded-full utility class from Tailwind CSS.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/image-4@2x.jpg" alt="sample 1" size="w-96" imgClass="h-96" class="rounded-full" />
+```
+
+## Image shadow
+
+This example can be used to show a shadow effect for the image using the shadow-size utility class.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/image-2@2x.jpg" alt="sample 1" size="max-w-xl" class="shadow-xl dark:shadow-gray-800" />
+```
+
+## Retina-ready
+
+Use the srcset attribute to set Retina-ready images with double resolution.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img srcset="/images/examples/image-1.jpg 1x, /images/examples/image-1@2x.jpg 2x" alt="sample 1" size="w-full max-w-xl" class="rounded-lg" />
+```
+
+## Image card
+
+Use this example to make the image a card item with a link and a short text description.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/content-gallery-3.png" alt="sample 1" class="rounded-lg" figClass="relative max-w-sm transition-all duration-300 cursor-pointer filter grayscale hover:grayscale-0" captionClass="absolute bottom-6 px-4 text-lg text-white" caption="Do you want to get notified when a new component is added to Flowbite?" />
+```
+
+## Image effects
+
+Use image effects such as grayscale or blur to change the appearances of the image when being hovered.
+
+### Grayscale
+
+Use the filter option and apply a grayscale to the image element using the grayscale class.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/content-gallery-3.png" size="max-w-lg" alt="My gallery" class="rounded-lg transition-all duration-300 cursor-pointer filter grayscale hover:grayscale-0" />
+```
+
+### Blur
+
+Apply a blur by using the blur-size utility class from Tailwind CSS to an image component.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/content-gallery-3.png" size="max-w-lg" alt="My gallery" class="rounded-lg transition-all duration-300 blur-sm hover:blur-none" />
+```
+
+## Alignment
+
+Align the image component to the left, center or right side of the document page using margin styles.
+
+### Left
+
+By default, the image component will be aligned to the left side of the page.
+
+```svelte example hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/image-1@2x.jpg" size="max-w-lg" alt="sample 1" />
+```
+
+### Center
+
+Horizontally align the image to the center of the page using the `mx-auto` class.
+
+```svelte example hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/image-1@2x.jpg" size="max-w-lg" alignment="mx-auto" alt="sample 1" />
+```
+
+### Right
+
+Use the `ml-auto` class to align the image to the right side of the page.
+
+```svelte example hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/image-1@2x.jpg" size="max-w-lg" alignment="ml-auto" alt="sample 1" />
+```
+
+## 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.
+
+### Small
+
+Use the `max-w-xs` class to set a small size of the image.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/image-1@2x.jpg" size="max-w-xs" alt="sample 1" />
+```
+
+### Medium
+
+Use the `max-w-md` class to set a medium size of the image.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/image-1@2x.jpg" size="max-w-md" alt="sample 1" />
+```
+
+### Large
+
+Use the max-w-xl class to set a large size of the image.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/image-1@2x.jpg" size="max-w-xl" alt="sample 1" />
+```
+
+### Full width
+
+Use the max-w-full class to set the full width of the image as long as it doesn’t become larger than the original source.
+
+```svelte example class="flex justify-center" hideScript
+<script>
+  import { Img } from 'flowbite-svelte';
+</script>
+
+<Img src="/images/examples/image-1@2x.jpg" size="max-w-full" alt="sample 1" />
+```
+
+## Component data
+
+The component has the following props, type, and default values. See [types page](/docs/pages/typescript) for type information.
+
+### Img Styling
+
+- Use the `class` prop to overwrite the `img` tag class.
+
+<CompoAttributesViewer {components}/>

package/src/routes/docs/typography/link.md

@@ -0,0 +1,147 @@
+---
+layout: componentLayout
+title: Svelte Links - Flowbite
+breadcrumb_title: Svelte Links
+component_title: Link
+dir: Typography
+description: 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
+thumnailSize: w-64
+---
+
+<script>
+  import { TableProp, TableDefaultRow, CompoAttributesViewer } from '../../utils'
+  import { A } from '$lib'
+  
+  const components = 'A'
+</script>
+
+Get started with the link component to enable hyperlinks across pages and external websites applied to elements such as inline text, buttons, cards, inside paragraphs, and more.
+
+Hyperlinks are a great way to reduce bounce rate of the current page and encourage visitors to browse your website and become a returning user.
+
+## Setup
+
+```html
+<script>
+  import { A } from 'flowbite-svelte';
+</script>
+```
+
+## Default link
+
+Use this example to set default styles to an inline link element.
+
+```svelte example
+<script>
+  import { A } from 'flowbite-svelte';
+</script>
+
+<A class="font-medium hover:underline">Read more</A>
+```
+
+## Button
+
+This example can be used to set a hyperlink on a button component.
+
+```svelte example
+<script>
+  import { Button } from 'flowbite-svelte';
+</script>
+
+<Button href="/">Read more</Button>
+```
+
+## Paragraph
+
+Use this example to set a link inside a paragraph with an underline style.
+
+```svelte example
+<script>
+  import { A, P } from 'flowbite-svelte';
+</script>
+
+<P>
+  The free updates that will be provided is based on the <A href="/" class="underline hover:no-underline">roadmap</A> that we have laid out for this project. It is also possible that we will provide extra updates outside of the roadmap as well.
+</P>
+```
+
+## Icon link
+
+This example can be used to set a custom SVG icon inside the hyperlink element.
+
+```svelte example
+<script>
+  import { A, P } from 'flowbite-svelte';
+  import { ArrowRightOutline } from 'flowbite-svelte-icons';
+</script>
+
+<P>
+  500,000 people have made over a million apps with Glide.
+  <A href="/" textColor="text-primary-600 dark:text-primary-500" aClass="inline-flex items-center font-medium  hover:underline">
+    Read their stories
+    <ArrowRightOutline class="w-4 h-4 ml-2" />
+  </A>
+</P>
+```
+
+## CTA link
+
+Use this example to set a hyperlink on a CTA element with text and a custom icon.
+
+```svelte example
+<script>
+  import { A } from 'flowbite-svelte';
+  import { ArrowRightOutline } from 'flowbite-svelte-icons';
+  import Figma from '../../utils/icons/Figma.svelte';
+</script>
+
+<A textColor="text-gray-500 dark:text-gray-400 dark:hover:text-white" aClass="inline-flex justify-center items-center p-5 text-base font-medium bg-gray-50 rounded-lg hover:text-gray-900 hover:bg-gray-100 dark:bg-gray-800 dark:hover:bg-gray-700">
+  <Figma />
+  <span class="w-full ml-3">Get started with our Figma Design System</span>
+  <ArrowRightOutline class="w-4 h-4 ml-2" />
+</A>
+```
+
+## Card link
+
+Use this example to set a hyperlink on a card component.
+
+```svelte example
+<script>
+  import { Card } from 'flowbite-svelte';
+</script>
+
+<Card href="/cards">
+  <h5 class="mb-2 text-2xl font-bold tracking-tight text-gray-900 dark:text-white">Noteworthy technology acquisitions 2021</h5>
+  <p class="font-normal text-gray-700 dark:text-gray-400 leading-tight">Here are the biggest enterprise technology acquisitions of 2021 so far, in reverse chronological order.</p>
+</Card>
+```
+
+## Image link
+
+This example can be used to set a hyperlink on an image inside a card component.
+
+```svelte example
+<script>
+  import { Card, Button } from 'flowbite-svelte';
+  import { ArrowRightOutline } from 'flowbite-svelte-icons';
+</script>
+
+<Card img="/images/image-1.webp" href="/cards">
+  <h5 class="mb-2 text-2xl font-bold tracking-tight text-gray-900 dark:text-white">Noteworthy technology acquisitions 2021</h5>
+  <p class="mb-3 font-normal text-gray-700 dark:text-gray-400 leading-tight">Here are the biggest enterprise technology acquisitions of 2021 so far, in reverse chronological order.</p>
+  <Button>
+    Read more <ArrowRightOutline class="w-3.5 h-3.5 ml-2" />
+  </Button>
+</Card>
+```
+
+## Component data
+
+The component has the following props, type, and default values. See [types page](/docs/pages/typescript) for type information.
+
+### A styling
+
+- Use the `class` prop to overwrite the `a` tag class.
+
+<CompoAttributesViewer {components}/>