@pushengineering/umg-web-components 2.0.3 → 2.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushengineering/umg-web-components",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "type": "module",
   "module": "dist/components/index.js",
   "files": [

package/readme.md

@@ -1,81 +1,34 @@
-# Table of Contents
 
-- [Table of Contents](#table-of-contents)
-- [UMG UX Components Library README](#umg-ux-components-library-readme)
-  - [Learn More about Web Components](#learn-more-about-web-components)
-- [Local Development Environment](#local-development-environment)
-  - [Prerequisites](#prerequisites)
-  - [Installation](#installation)
-  - [Build scripts](#build-scripts)
-- [Lit - Lightning-Fast Components](#lit---lightning-fast-components)
-- [Storybook Integration for Component Previews and Documentation](#storybook-integration-for-component-previews-and-documentation)
+# UMG Web Components Library
+This library provides a collection of native UX web components built with [Lit](https://lit.dev/docs/).  
+The components are designed to be fast, reusable, and highly customisable for any project, without relying on proprietary technologies or frameworks. They leverage standard Web APIs and are compatible with all modern browsers.  
 
-# UMG UX Components Library README
-Welcome to the UMG UX Components Library! This library provides a collection of UX frontend components designed to be fast, reusable, and highly customisable for any project, without relying on proprietary technologies or frameworks. These components leverage standard Web APIs and are compatible with all modern browsers.
+Components are exported as native ES Modules and can be directly used in web applications using raw module imports. If your application does not support native modules, tools like Rollup or Webpack can be used to prepare the components for serving in your production environment as needed.  
 
-## Learn More about Web Components
-To deepen your understanding of web components, their key concepts, and the specific web APIs we employ, we recommend reading the [MDN guide on Web Components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components).
-
-  
-# Local Development Environment
-
-## Prerequisites
-
-Before you begin, make sure you have the following prerequisites installed on your system:  
-
-Node.js v16.14 or higher. You can download it from [here](https://nodejs.org/en/download)  
-[PNPM](https://pnpm.io/) v8 or higher. Install it via these links: [Mac](https://github.com/nvm-sh/nvm) | [Windows](https://github.com/coreybutler/nvm-windows)
+To keep code sizes to a minimum Lit is not exported with the library and will need to be installed as a dependency of your project.  
 
 ## Installation
-1. Install Node.js globally using one of the following methods:
-- Mac: [NVM](https://github.com/nvm-sh/nvm)
-- Windows: [NVM for Windows](https://github.com/coreybutler/nvm-windows)
-- Direct download: [Node.js](https://nodejs.org/en/download)
-
-2. Install PNPM globally using one of the following methods:
-- Mac: ``brew install pnpm``
-- Windows PowerShell: Run the command ``iwr https://get.pnpm.io/install.ps1 -useb | iex``  
-
-For more details, check the: [PNPM documentation](https://pnpm.io/)
-
-1. Clone the project repository using this command:  
-   ```
-   git clone git@github.com:Push-Entertainment/umg-component-library.git
-   ```
 
-2. Initialise the project by running the following command in your terminal within the project's root directory:  
-   ```
-   pnpm install
-   ```
+Install the package as dependency of your application:  
 
-## Build scripts
+`npm i @pushengineering/umg-web-components`  
+`yarn add @pushengineering/umg-web-components`  
+`pnpm add @pushengineering/umg-web-components`  
 
-We've provided various build scripts to streamline your development process:
+Install Lit as a dependency:  
 
-- Develop components: `pnpm dev`
-- Develop Storybook: `pnpm dev-storybook`
-- Build components and design tokens: `pnpm build`
-- Build components, design tokens and Storybook static site: `pnpm build-all`
-- Build design tokens: `pnpm build-tokens`
-- Build Storybook static site: `pnpm build-storybook`
-
-# Lit - Lightning-Fast Components
-
-Our library is built using Lit, a framework that simplifies component development without sacrificing performance or relying on non-standard frameworks. Lit builds on web component standards, is lightweight, and reduces boilerplate code. You can find Lit 2's documentation [here](https://lit.dev/docs/).
-
-To save time, minimise errors, and future-proof your code, we've written this library in TypeScript and utilise Lit's decorator methods, which TypeScript transpiles into browser-compatible JavaScript.
-
-# Storybook Integration for Component Previews and Documentation
-
-We've seamlessly integrated Storybook into our component library to provide you with a powerful playground tool with component previews and comprehensive documentation. Storybook serves as a valuable resource for both developers and designers, offering a visual representation of each component's behavior and appearance in different scenarios.
-
-- Exploring Components in Storybook
-With Storybook, you can easily navigate and explore our components:
-
-- Preview Components: View live, interactive previews of each component to understand how they look and behave in various situations.
+`npm i lit`  
+  
+## Further information
 
-- Component Variations: Explore different variations and configurations of each component, helping you tailor them to your specific project requirements.
+[Push Engineering Git Repository](https://github.com/Push-Entertainment/umg-component-library)  
 
-- Interactive Documentation: Access detailed documentation and usage examples for each component, making it easier to implement them effectively in your project.
+## Release Version 2
+- Supports UMG Grand Royal layouts:
+  - Single Slick V1 themes
+  - Multipage Slick V1 themes
 
-The Storybook application can be loaded into a browser by running `pnpm dev-storybook` in `node_modules/@pushengineering/umg-components`.
+### Patches in this release
+- Social component
+  - Social icon links target property was not being passed to child button icons.
+  - Missing social icons previously added to the Icon component had not merged into the main release branch.