@tui/design-system 0.1.1-MR-234.0 → 1.0.0

package/CHANGELOG.md

@@ -28,10 +28,10 @@ Modals and Accordions.
 | Flight Details    | Presents comprehensive information about a holiday's flights.                                                                  |
 | Info Tag          | Highlights promotional/branded content (Neutral, Info, Scarcity, Local).                                                       |
 | Media Button      | Specific trigger for opening media galleries.                                                                                  |
-| Percentage review | Currently used for HolidayCheck reviews within in the Central Region market to show a hotel rating based on guest reviews.     |
+| Percentage review | Currently used for HolidayCheck reviews within the Central Region market to show a hotel rating based on guest reviews.        |
 | Rich Text         | A wrapper to automatically style raw HTML content from CMS/APIs.                                                               |
-| Show more or less | Used to hide and reveal content, in order to save space and support visual balance and hierarchy or information.               |
-| Skeleton          | Placeholder loading states with synchronized shimmer animations.                                                               |
+| Show more or less | Hides and reveals content to save space and support visual hierarchy.                                                          |
+| Skeleton          | Placeholder loading states with synchronised shimmer animations.                                                               |
 
 ### Removals
 
@@ -62,15 +62,15 @@ Modals and Accordions.
 - Tokens
   - All tokens have been updated to match the token naming for the master figma files. This has resulted in a vastly reduced number of base tokens
     that reference primitive variables for each theme. Individual components may have their own tokens that map back to these base tokens for each
-    theme as nessessary.
-- App height is now set to 100dvh removing the requirement to use JS to fix the viewport height on mobile devices when the browser toolbars disapear
+    theme as necessary.
+- App height is now set to 100dvh removing the requirement to use JS to fix the viewport height on mobile devices when the browser toolbars disappear
   on scroll.
 
 #### [Typography](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/globals-typography--docs)
 
 - All webfonts have fallbacks with f-mods specified to minimise CLS when the webfonts load
 - New mixin for generic heading and copy styling classes
-- Modifer mixin updated to remove options covered by css variables
+- Modifier mixin updated to remove options covered by css variables
 
 #### [Breakpoints](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/globals-breakpoints--docs)
 
@@ -83,24 +83,23 @@ Modals and Accordions.
 
 #### [Accordion](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-accordion--docs)
 
-- Reduced down to single variant with border, also replacing elevations.
-- Two group styling options available
-- Option to include a logo next to the accordion heading has been added for where a collection of logos is required
-- Notification label replaced by option to include a sub title
+- Reduced to a single border variant, replacing elevation styles.
+- Two group styling options are now available.
+- Added option to include a logo next to the accordion heading, for use when displaying a collection of logos.
+- Replaced notification label with an optional subtitle.
 - Mixins simplified so variants and states are all baked into the main uilib-accordion mixin, with a second mixin uilib-accordion-group for styling
   groups of accordions
 - Rebuilt to use native details, summary elements; fixing various accessibility and usability issues
-- JavaScript provided to support expand/collapse all functionality where 5 or more accordions are in a group.
+- Added JavaScript to support expand/collapse-all functionality when five or more accordions are in a group.
 
 #### [Active tag](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-active-tag--docs)
 
-- New component added to indicate which filters are currently applied. They allow users to easily modify their search and filtering criteria, making
-  the results easier to refine.
+- New component for indicating which filters are currently applied. Allows users to modify search and filtering criteria to refine results.
 
 #### [Alert](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-alert--docs)
 
 - Mixins simplified so variants are all baked into the main `uilib-alert mixin`
-- Default variant has been removed in line with 1web design patterns
+- Removed the default variant to align with 1web design patterns.
 
 #### Badge
 
@@ -108,31 +107,33 @@ Modals and Accordions.
 
 #### [Breadcrumb](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-breadcrumb--docs)
 
-- Created new component, all the styles are baked into a single `uilib-breadcrumb mixin`
-- Breadcrumb inherits styles from it's base Link and Icon components
+- New component with all styles baked into a single `uilib-breadcrumb` mixin.
+- Breadcrumb inherits styles from its base Link and Icon components
 
 #### [Button](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-button--docs)
 
 - Mixins simplified so variants, states and sizes are all baked into the main `uilib-button mixin`
-- Button styling has been aligned with the latest 1web designs across all themes
+- Button styling aligned with the latest 1web designs across all themes.
 
-#### [Card](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-cards-card--docs)
+#### Cards
+
+##### [Card](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-cards-card--docs)
 
 - Card added to group related content into a structured, scannable surface.
 
-### [Card article](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-cards-article-card--docs)
+##### [Card article](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-cards-article-card--docs)
 
 - Card added to show information on the inspire and browse pages. It always has an image in the card.
 
-### [Card icon](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-cards-icon-card--docs)
+##### [Card icon](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-cards-icon-card--docs)
 
 - Card added to show information on the inspire and browse pages, portraying information primarily through icons and pictograms.
 
-#### [Card search](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-cards-search-card--docs)
+##### [Card search](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-cards-search-card--docs)
 
-- Card added to contain a summary of information for a product in a set of results.
+- Card added for displaying a product summary within search results.
 
-#### [Card selectable](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-cards-selectable-card--docs)
+##### [Card selectable](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-cards-selectable-card--docs)
 
 - Card split from basic card to provide users with detailed selectable options. This card has support for static display as well as interactive with
   radio or checkbox inputs.
@@ -146,12 +147,12 @@ Modals and Accordions.
 
 #### Eye catcher
 
-- Removed from the design system. There is not replacement for this component.
+- Removed from the design system. There is no replacement for this component.
 
 #### [Flight details](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-flight-details--docs)
 
-- New flight details has been added. It presents comprehensive information about a holiday's flights
-- Two variants are available allowing for the display of both direct and indirect flights
+- New component for presenting comprehensive flight information for holidays.
+- Two variants available: one for direct flights and one for indirect flights.
 
 #### Forms
 
@@ -161,24 +162,24 @@ Modals and Accordions.
 - Separate day component removed and baked into the date picker
 - Sheet variant removed
 - Converted to a web component that will populate a date input field with the selected value
-- Inclusion of support for week number column for the Nordics market
+- Added support for a week number column for the Nordics market.
 
 ##### [Form row](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-forms-form-row--docs)
 
-- Replacing base input styling provided in v4, including styles for label, hint text, spacing around any input and error messaging
+- Replaces the base input styling from v4, covering label, hint text, input spacing, and error messaging.
 - Support for success messaging removed
 
 ##### [Input checkbox](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-forms-input-checkbox--docs)
 
 - Mixins simplified to one main `uilib-input-checkbox` mixin
 - Error, valid states removed
-- New checkbox label variant options included
-- New confirmation checkbox variant included
+- Added new checkbox label variant options.
+- Added new confirmation checkbox variant.
 
 ##### [Input Chip](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-forms-input-chip--docs)
 
 - Mixins simplified to one main `uilib-input-chip` mixin
-- New month-calendar variant included
+- Added new month-calendar variant.
 
 ##### [Input count](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-forms-input-count--docs)
 
@@ -186,19 +187,19 @@ Modals and Accordions.
 - Variants removed to match latest 1web designs
 - Error, valid and disabled states removed
 - Count limited to maximum of 7 options
-- Can now support text as well as numbers within the count input
+- Now supports text values in addition to numbers.
 
 ##### [Input radio](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-forms-input-radio--docs)
 
 - Mixins simplified to one main `uilib-input-radio` mixin
 - Error, valid states removed
-- New radio label variant options included
+- Added new radio label variant options.
 
 ##### [Input select](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-forms-input-select--docs)
 
 - Mixins simplified to one main `uilib-input-select` mixin
 - Floating label option and valid state have been removed
-- Ability to include a leading icon added
+- Added support for a leading icon.
 
 ##### [Input slider](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-forms-input-slider--docs)
 
@@ -210,7 +211,7 @@ Modals and Accordions.
 
 - Mixins simplified to one main `uilib-input-stepper` mixin
 - Control and input sizes have been adjusted to match latest 1web designs
-- Web component provided to include increment and decrement controls to update the original text input
+- Added a web component that provides increment and decrement controls for the text input.
 
 ##### [Input switch](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-forms-input-switch--docs)
 
@@ -220,8 +221,8 @@ Modals and Accordions.
 
 - Mixin renamed to `uilib-input-text`
 - Floating label, placeholder and readonly options have been removed
-- Valid state usage rules and styling updated
-- Web component provided to clear prefilled inputs, clear search inputs and toggle view of password fields
+- Updated valid-state usage rules and styling.
+- Added a web component to clear prefilled and search inputs, and to toggle password field visibility.
 
 ##### [Textarea](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-forms-textarea--docs)
 
@@ -235,8 +236,7 @@ Modals and Accordions.
 #### [Hero (formerly header)](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-hero--docs)
 
 - Mixins simplified so size options are now baked into the main `uilib-hero mixin`
-- Hero now includes styling for the content area overlay supporting left, right and center positioning as well as standard, slim and illustration
-  heros
+- Now includes content-area overlay styling with left, right, and centre positioning, as well as standard, slim, and illustration hero variants.
 
 #### [Icon](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-icon--docs)
 
@@ -250,17 +250,17 @@ Modals and Accordions.
 - Half icon button has been removed
 - New control, promotion, search and shortlist variants added
 - Elevation option has been removed and automatically applied to control variant
-- Button styling has been aligned with the latest 1web designs across all themes
+- Button styling aligned with the latest 1web designs across all themes.
 
 #### [Image (picture)](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-image--docs)
 
 - Mixins simplified so shapes and ratios are all baked into the main `uilib-image` mixin
-- Added ability to control the focal point if the source image is cropped by the focal point option
-- Error handling with fallback image has been added.
+- Added a focal-point option to control cropping of the source image.
+- Added error handling with a fallback image.
 
 #### Image counter
 
-- Removed from the design system. There is not replacement for this component.
+- Removed from the design system. There is no replacement for this component.
 
 #### [Info tag](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-info-tag--docs)
 
@@ -283,14 +283,14 @@ Modals and Accordions.
 
 - Mixins simplified so size options are now baked into the main `uilib-loader` mixin
 - TUI ripple loader option removed
-- Snowflake and FC-loader options are now controlled by theming rather than being specific options
-- Option to include visible loading message now included for all size variants
-- Overlay mixin removed with no replacement. Placement of loader is developers responsibility. The loader will always position centered (vertically
-  and horizontally) within the 'uilib-loader' element.
+- Snowflake and FC-loader styles are now controlled by theming rather than being separate component options.
+- Added option to display a visible loading message for all size variants.
+- Overlay mixin removed with no replacement. Placement of loader is the developer's responsibility. The loader will always position centered
+  (vertically and horizontally) within the 'uilib-loader' element.
 
 #### [Media button](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-media-button--docs)
 
-- New media button has been added for opening media galleries
+- New component for triggering media gallery overlays.
 
 #### [Modal](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-modal--docs)
 
@@ -300,7 +300,7 @@ Modals and Accordions.
 - Sticky header and footer when content is scrollable
 - Optional navigation slot for moving between modal states
 - NoJS example with fallback to dedicated page
-- Full-width drawer on mobile devices
+- Displays as a full-width bottom drawer on mobile.
 
 #### [Pagination](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-pagination--docs)
 
@@ -323,8 +323,8 @@ Modals and Accordions.
 ##### [Numerical](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-ratings-and-reviews-numerical--docs) (previously Review base variant)
 
 - Mixins simplified to single mixin controlling numerical rating/review styles `uilib-ratings-numerical`
-- Now single size option available with small and xsmall being removed
-- New variant added for providing alternative styling to use with musement ratings
+- Reduced to a single size option; small and xsmall sizes removed.
+- Added a new variant with alternative styling for Musement ratings.
 
 ##### [Percentage](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-ratings-and-reviews-percentage--docs)
 
@@ -334,44 +334,44 @@ Modals and Accordions.
 ##### [Range bar](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-ratings-and-reviews-range-bar--docs) (previously Review range, and rangeBar variants)
 
 - Mixins simplified to single mixin controlling range bar rating/review styles `uilib-ratings-range-bar`
-- Component now includes label (with icon for customer review variant)
+- Now includes a label, with an icon for the customer review variant.
 
 ##### [Range icons](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-ratings-and-reviews-range-icons--docs) (previously Rating, and Review range variant)
 
 - Mixins simplified to single mixin controlling range icon rating/review styles `uilib-ratings-range-icons`
-- Added tripadvisor variant
+- Added Tripadvisor variant.
 - Group styling option included
 
 ##### [Range icon group](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-ratings-and-reviews-range-icons-group--docs)
 
-- New component to display lists of range icons for use with the likes of TripAdvisor
+- New component for displaying grouped range icons, such as those used for TripAdvisor ratings.
 
 #### [Rich Text](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-rich-text--docs)
 
-- New component added that provides a wrapper that automatically styles basic html content such as headings, paragaphs, links, lists etc. This allows
-  for simple and consistent styling of rich text content from CMS/APIs.
+- New wrapper component that automatically styles basic HTML content (headings, paragraphs, links, lists, etc.) for consistent rendering of CMS/API
+  rich text.
 
 #### [Scroller](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-scroller--docs)
 
 - Mixins simplified so scrollbar and fade-out options are baked into a single `uilib-scroller` mixin
 - Fade is applied by default
 - Fade effect is applied via modern CSS techniques
-- Small web component provided to improve accessibility support
+- Added a small web component to improve accessibility.
 
 #### [Show more/less](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-show-more-or-less--docs)
 
-- New component added to hide and reveal content, in order to save space and support visual balance and hierarchy or information
-- Two variants available. Default displays the first paragraph of content hiding the rest, Text only truncates a block of content (for use with
-  content such as customer reviews)
+- New component for hiding and revealing content to save space and support visual hierarchy.
+- Two variants available: Default shows the first paragraph and hides the rest; Text Only truncates a block of content (for use with customer reviews,
+  etc.).
 
 #### [Skeleton](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-skeleton--docs)
 
 - Mixins simplified to single `uilib-skeleton` mixin with all variants and utilities baked in
-- Synchronized shimmer animation across all skeleton elements using CSS custom properties
+- Synchronised shimmer animation across all skeleton elements using CSS custom properties
 - Multiple skeleton types available: heading, subheading, text, circle, card, and container
 - Width utilities from 10% to 100% in 10% increments, with responsive variants for xs breakpoint
 - Height utilities from 1rem to 20rem in 1rem increments
-- Layout helper classes for organizing skeleton elements with flexible gap and direction options
+- Layout helper classes for organising skeleton elements with flexible gap and direction options
 - Outlined variant with border and transparent background
 - Spacer variant for creating transparent gaps without animation
 - Respects prefers-reduced-motion for accessibility
@@ -379,14 +379,14 @@ Modals and Accordions.
 
 #### Tabs ([Anchor](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-tabs-tabs-anchor--docs) and [In page](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-tabs-in-page-tabs--docs))
 
-- Tab and tab list replaced by two Anchor tabs and In page tabs. Anchor tabs are for linking to content sections within the same page where as in page
-  tabs switch between content sections without navigation or page reloads
+- Tab and tab list replaced by two new components: Anchor tabs and In-page tabs. Anchor tabs link to content sections within the same page; In-page
+  tabs switch between content sections without navigation or page reloads.
 - Mixins simplified to one main mixin for each tab type (anchor and in page)
 - JavaScript controls tab behaviour, including accessibility requirements, with non-JavaScript fallback provided
 
-#### [Toolip](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-tooltip--docs)
+#### [Tooltip](https://mwa.tui.com/browse/mwa/uilib-production/storybook/index.html?path=/docs/components-tooltip--docs)
 
 - Mixins simplified to one main `uilib-tooltip` mixin
 - Tooltip now opens on click or enter rather than hover
 - JavaScript controls tooltip positioning and ensures the tooltip is read by assistive technologies, with a non-JavaScript fallback provided
-- Hit target for icon variant increased improving accessibility for all user
+- Increased the hit target for the icon variant, improving accessibility.

package/README.md

@@ -59,7 +59,7 @@ components, how themes are generated, the original unprocessed stylesheets (post
 Your feedback is welcome. You may request changes and improvements by creating an Issue on the
 [UI Library (UILIB)](https://tui.atlassian.net/jira/software/c/projects/UILIB/boards/2275/backlog) project in Jira. If you have a general query about
 the Design System you are welcome to post in the
-[UI Library Support channel](https://teams.microsoft.com/l/channel/19%3A537d7e30d4284701a3b985a0763f7b2e%40thread.tacv2/Support%20UI%20Library?groupId=237c9a11-b89a-449e-8d69-416a09bd8f55&tenantId=e3e1f65b-b973-440d-b61c-bc895fc98e28)
+[Design System Support channel](https://teams.microsoft.com/l/channel/19%3A2YJWcKc39k5Ve1VQK034fMAez4tGZb1mCGCAhXA0Il01%40thread.tacv2/General?groupId=40d60389-22ad-4003-8dc1-8658a5c871d8&tenantId=e3e1f65b-b973-440d-b61c-bc895fc98e28)
 on Teams.
 
 Please check the [contributing document](/docs/CONTRIBUTING.md) and the [guidelines](/docs/GUIDELINES.md) for contribution.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tui/design-system",
-	"version": "0.1.1-MR-234.0",
+	"version": "1.0.0",
 	"description": "TUI Design System",
 	"author": "TUI Group",
 	"contributors": [