flowbite-svelte 0.44.11 → 0.44.12

package/src/routes/docs/components/rating.md

@@ -1,326 +0,0 @@
----
-layout: componentLayout
-title: Svelte Rating - Flowbite
-breadcrumb_title: Svelte Rating
-component_title: Rating
-dir: Components
-description: Use the rating component to show reviews and testimonials from your users using stars and scores based on multiple styles and sizes
-thumnailSize: w-64
----
-
-<script>
-  import { TableProp, TableDefaultRow, CompoAttributesViewer } from '../../utils'
-  import { P, A } from '$lib'
-
-  const components = 'Rating, AdvancedRating, ScoreRating, RatingComment, Review, Star, Thumbup, Heart'
-</script>
-
-Get started with the rating component to show an aggregate of reviews and scores in the forms of stars or numbers.
-
-You can find multiple examples on this page including different styles, sizes, and variants of the rating component and other associated elements such as a comment or card.
-
-## Setup
-
-Let's import all necessary components in the script tag. We import a heart, thumb-up, and smiley icons, but you can use any icons as you like.
-
-```svelte example hideOutput
-<script>
-  import { Rating, AdvancedRating, ScoreRating } from 'flowbite-svelte';
-</script>
-```
-
-## Default rating
-
-The default rating icon is a star. Set the total and rating props. The `id` prop is required. Use a unique name.
-
-```svelte example hideScript
-<script>
-  import { Rating } from 'flowbite-svelte';
-</script>
-
-<Rating id="example-1" total={5} size={50} rating={1.4} />
-<Rating id="example-1b" total={5} size={50} rating={4.66} />
-```
-
-## Stars
-
-You can use the Star component with the `id` and `fillPercent` props.
-
-```svelte example
-<script>
-  import { Star } from 'flowbite-svelte';
-</script>
-
-<Star size={50} id="0" fillPercent={0} />
-<Star size={50} id="10" fillPercent={10} />
-<Star size={50} id="20" fillPercent={20} />
-<Star size={50} id="30" fillPercent={30} />
-<Star size={50} id="40" fillPercent={40} />
-<Star size={50} id="50" fillPercent={50} />
-<Star size={50} id="60" fillPercent={60} />
-<Star size={50} id="70" fillPercent={70} />
-<Star size={50} id="80" fillPercent={80} />
-<Star size={50} id="90" fillPercent={90} />
-<Star size={50} id="100" fillPercent={100} />
-```
-
-## Rating with text
-
-If you also want to show a text near the stars you can use the `text` slot to add any text.
-
-```svelte example hideScript
-<script>
-  import { Rating } from 'flowbite-svelte';
-</script>
-
-<Rating id="example-3" total={5} rating={3.4}>
-  <p slot="text" class="ml-2 text-sm font-medium text-gray-500 dark:text-gray-400">3.4 out of 5</p>
-</Rating>
-```
-
-## Rating count
-
-Aggregate more results by using this example to show the amount of reviews and the average score.
-
-```svelte example hideScript
-<script>
-  import { Rating } from 'flowbite-svelte';
-</script>
-
-<Rating count rating={4.95} id="example-4">
-  <span class="w-1 h-1 mx-1.5 bg-gray-500 rounded-full dark:bg-gray-400" />
-  <a href="/" class="text-sm font-medium text-gray-900 underline hover:no-underline dark:text-white"> 73 reviews </a>
-</Rating>
-```
-
-## Icon size and color
-
-### Size and color
-
-The default icon size is `24`. Import your icon and set it in a icon props.
-
-```svelte example
-<script>
-  import { Rating, Heart } from 'flowbite-svelte';
-</script>
-
-<Rating total={5} rating={3.3} id="example-5" icon={Heart} />
-<Rating total={10} rating={7.6} id="example-5b" icon={Heart} />
-```
-
-```svelte example
-<script>
-  import { Rating, Thumbup } from 'flowbite-svelte';
-</script>
-
-<Rating total={5} rating={4.7} id="example-5c" icon={Thumbup} />
-<Rating total={10} rating={8.2} id="example-5d" icon={Thumbup} />
-```
-
-## AdvancedRating component
-
-Set the `total`,` rating`, and `ratings` prop for AdvancedRation component. Use the `rating` slot for Rating component with the `total` and `rating` props. Use the `globalText` slot for additional information.
-
-```svelte example
-<script>
-  import { AdvancedRating, Rating } from 'flowbite-svelte';
-</script>
-
-<AdvancedRating
-  ratings={[
-    { label: '5 star', rating: 70 },
-    { label: '4 star', rating: 17 },
-    { label: '3 star', rating: 8 },
-    { label: '2 star', rating: 4 },
-    { label: '1 star', rating: 1 }
-  ]}>
-  <span slot="rating">
-    <Rating total={5} rating={3.72} id="example-8">
-      <p slot="text" class="text-sm font-medium text-gray-500 dark:text-gray-400 ml-2">3.72 out of 5</p>
-    </Rating>
-  </span>
-  <p slot="globalText" class="mt-2 text-sm font-medium text-gray-500 dark:text-gray-400">1,745 global ratings</p>
-</AdvancedRating>
-```
-
-## Different icon
-
-As we describe in the Rating component, you can change an icon in the Rating component.
-
-```svelte example
-<script>
-  import { AdvancedRating, Rating, Thumbup } from 'flowbite-svelte';
-</script>
-
-<AdvancedRating
-  ratings={[
-    { label: '5 star', rating: 70 },
-    { label: '4 star', rating: 17 },
-    { label: '3 star', rating: 8 },
-    { label: '2 star', rating: 4 },
-    { label: '1 star', rating: 1 }
-  ]}>
-  <span slot="rating">
-    <Rating total={5} rating={3.8} icon={Thumbup} id="example-9">
-      <p slot="text" class="text-sm font-medium text-gray-500 dark:text-gray-400 ml-2">3.8 out of 5</p>
-    </Rating>
-  </span>
-  <p slot="globalText" class="mt-2 text-sm font-medium text-gray-500 dark:text-gray-400">1,745 global ratings</p>
-</AdvancedRating>
-```
-
-## Score rating
-
-```svelte example
-<script>
-  import { ScoreRating } from 'flowbite-svelte';
-  let headerLabel = {
-    desc1: '8.7',
-    desc2: 'Excellent',
-    desc3: '376 reviews',
-    link: {
-      label: 'Read all reviews',
-      url: '/'
-    }
-  };
-</script>
-
-<ScoreRating
-  {headerLabel}
-  ratings={[
-    { label: 'Staff', rating: 8.8 },
-    { label: 'Comfort', rating: 8.9 },
-    { label: 'Free WiFi', rating: 8.8 },
-    { label: 'Facilities', rating: 5.4 }
-  ]}
-  ratings2={[
-    { label: 'Value for money', rating: 8.9 },
-    { label: 'Cleanliness', rating: 7.0 },
-    { label: 'Location', rating: 8.0 }
-  ]} />
-```
-
-## Rating comment
-
-Use this component to show a single rating comment and its score alongside other components such as the user profile avatar, name, post date, and more.
-
-```svelte example
-<script>
-  import { RatingComment } from 'flowbite-svelte';
-  let comment = {
-    id: '1',
-    user: {
-      name: 'Jese Leos',
-      img: {
-        src: '/images/profile-picture-2.webp',
-        alt: 'Jese Leos'
-      },
-      joined: 'Joined on August 2014'
-    },
-    total: 5,
-    rating: 4.5,
-    heading: 'Thinking to buy another one!',
-    address: 'the UK',
-    datetime: '2022-03-25'
-  };
-</script>
-
-<RatingComment {comment} helpfullink="/" abuselink="/">
-  <p class="mb-2 font-light text-gray-500 dark:text-gray-400">This is my third Invicta Pro Diver. They are just fantastic value for money. This one arrived yesterday and the first thing I did was set the time, popped on an identical strap from another Invicta and went in the shower with it to test the waterproofing.... No problems.</p>
-  <p class="mb-3 font-light text-gray-500 dark:text-gray-400">It is obviously not the same build quality as those very expensive watches. But that is like comparing a Citroën to a Ferrari. This watch was well under £100! An absolute bargain.</p>
-  <a href="/" class="block mb-5 text-sm font-medium text-primary-600 hover:underline dark:text-primary-500"> Read more </a>
-  <svelte:fragment slot="evaluation">19 people found this helpful</svelte:fragment>
-</RatingComment>
-```
-
-## Review content
-
-Use this component to show the review content from a user alongside the avatar, location, details, and the score inside a card element.
-
-```svelte example
-<script>
-  import { Review } from 'flowbite-svelte';
-  import { LandmarkSolid, CalendarMonthSolid, UsersGroupOutline, ThumbsUpSolid, ThumbsDownSolid } from 'flowbite-svelte-icons';
-  let review = {
-    name: 'Jese Leos',
-    imgSrc: '/images/profile-picture-2.webp',
-    imgAlt: 'jese leos',
-    address: 'United States',
-    reviewDate: 'January 20, 2022',
-    title: 'Spotless, good appliances, excellent layout, host was genuinely nice and helpful.',
-    rating: 8.79,
-    item1: 'Apartament with City View',
-    item2: '3 nights December 2021',
-    item3: 'Family'
-  };
-</script>
-
-<Review {review}>
-  <p class="mb-2 font-light text-gray-500 dark:text-gray-400">The flat was spotless, very comfortable, and the host was amazing. I highly recommend this accommodation for anyone visiting Brasov city centre. It's quite a while since we are no longer using hotel facilities but self contained places. And the main reason is poor cleanliness and staff not being trained properly. This place exceeded our expectation and will return for sure.</p>
-  <p class="mb-5 font-light text-gray-500 dark:text-gray-400">It is obviously not the same build quality as those very expensive watches. But that is like comparing a Citroën to a Ferrari. This watch was well under £100! An absolute bargain.</p>
-  <svelte:fragment slot="item1">
-    <LandmarkSolid class="w-3 h-3 mr-2" />
-    {review.item1}
-  </svelte:fragment>
-  <svelte:fragment slot="item2">
-    <CalendarMonthSolid class="w-3 h-3 mr-2" />
-    {review.item2}
-  </svelte:fragment>
-  <svelte:fragment slot="item3">
-    <UsersGroupOutline class="w-3 h-3 mr-2" />
-    {review.item3}
-  </svelte:fragment>
-  <aside class="flex items-center mt-3 space-x-5">
-    <a href="/" class="inline-flex items-center text-sm font-medium text-primary-600 hover:underline dark:text-primary-500">
-      <ThumbsUpSolid class="w-3.5 h-3.5 mr-2.5 text-primary-600 dark:text-primary-500" />
-      Helpful
-    </a>
-    <a href="/" class="inline-flex items-center text-sm font-medium text-primary-600 hover:underline dark:text-primary-500 group">
-      <ThumbsDownSolid class="w-3.5 h-3.5 mr-2.5 text-primary-600 dark:text-primary-500" />
-      Not helpful
-    </a>
-  </aside>
-</Review>
-```
-
-## Component data
-
-The component has the following props, type, and default values. See [types page](/docs/pages/typescript) for type information.
-
-### Rating styling
-
-- Use the `class` prop to overwrite `divClass`.
-
-### AdvancedRating styling
-
-- Use the `classDiv` prop to overwrite `divClass`.
-- Use the `classLabel` prop to overwrite `labelClass`.
-- Use the `classRatingDiv` prop to overwrite `ratingDivClass`.
-- Use the `classRating` prop to overwrite `ratingClass`.
-- Use the `classRightLabel` prop to overwrite `rightLabelClass`.
-
-### Review styling
-
-- Use the `classArticle` prop to overwrite `articleClass`.
-- Use the `classDiv` prop to overwrite `divClass`.
-- Use the `classImg` prop to overwrite `imgClass`.
-- Use the `classUl` prop to overwrite `ulClass`.
-- Use the `classLi` prop to overwrite `liClass`.
-
-### Star styling
-
-- Use the `class` prop to overwrite the `svg` tag class.
-
-### Thumbup styling
-
-- Use the `class` prop to overwrite the `svg` tag class.
-
-### Heart styling
-
-- Use the `class` prop to overwrite the `svg` tag class.
-
-<CompoAttributesViewer {components}/>
-
-## References
-
-- [Flowbite Rating](https://flowbite.com/docs/components/rating/)