@cruk/chakra-components 3.0.1 → 3.0.3

package/README.md

@@ -1,4 +1,5 @@
 ![Logo](.github/assets/logo.png)
+
 # CRUK Chakra Components 🎨
 
 A [Chakra UI v2](https://v2.chakra-ui.com/docs/) based component library that provides styled components following the [Cancer Research UK Helix design system](https://zeroheight.com/721bd94bd/p/074a6c-helix-design-system---cancer-research-uk) 🧬.
@@ -27,8 +28,8 @@ npm install @chakra-ui/react @emotion/react @emotion/styled framer-motion
 
 **NOTE:** Not all projects use `npm` as their package managers, use whichever is appropriate for your project.
 
-
 ### Basic Setup
+
 Once added to the project, you can use the `ChakraBaseProvider` to wrap your application and provide styled based on the `crukBrand` theme.
 
 ```typescript
@@ -44,7 +45,6 @@ const App = ({ Component, pageProps }: AppProps) => (
 export default App;
 ```
 
-
 - 📖 [Styling documentation](https://super-succotash-wg8qmo1.pages.github.io/styling)
 - 📖 [Theming documentation](https://super-succotash-wg8qmo1.pages.github.io/theming)
 
@@ -53,6 +53,7 @@ export default App;
 ### Development Setup
 
 After cloning the repository, install the dependencies:
+
 ```bash
 # Clone and setup
 git clone https://github.com/CRUKorg/cruk-chakra-components
@@ -64,6 +65,7 @@ npm run storybook
 ```
 
 ### Quick Test
+
 ```bash
 npm run test     # Unit tests
 npm run test-ct  # Component tests
@@ -73,55 +75,87 @@ npm run test-ct  # Component tests
 
 ### Release Process
 
-This library uses [semantic-release](https://github.com/semantic-release/semantic-release) to automate versioning and package publishing.
+This library uses [semantic-release](https://github.com/semantic-release/semantic-release) to automate versioning and package publishing based on **pull request titles** and **commit content**.
 
 #### Branch Strategy
 
 - `dev` branch: Configured as a prerelease branch with the `dev` prerelease tag
 - `main` branch: Configured as a regular release branch
 
-#### Creating a Standard Release
+#### Release Requirements
 
-To create a standard release (patch or minor version):
+**Important:** Only pull requests with `RELEASE` in the title will trigger a release. The version type (major/minor/patch) is determined by the commit content within that PR.
+
+#### Creating a Release
+
+1. **Create your pull request with `RELEASE` in the title:**
 
-1. Create a commit with the appropriate type and include `RELEASE` in the message:
-   ```
-   feat: add new Button variant *RELEASE*
-   ```
-   or
    ```
-   fix: resolve Button focus state issue *RELEASE*
+   RELEASE: Add new Button component
+   RELEASE: Fix accessibility issues
+   Feature update - RELEASE v2.1.0
    ```
 
-2. Push your changes to the appropriate branch:
-   ```bash
-   git push origin dev    # For prerelease
-   git push origin main   # For standard release
+2. **Use conventional commit messages** within your PR to determine the release type:
+
+   **Patch Release** (v1.0.0 → v1.0.1):
+
+   ```
+   fix: resolve Button focus state issue
+   docs: update component documentation
+   test: add missing unit tests
+   refactor: improve component structure
    ```
 
-3. The release will be automatically triggered by the CI/CD pipeline.
+   **Minor Release** (v1.0.0 → v1.1.0):
 
-#### Creating a Breaking Change
+   ```
+   feat: add new Button variant
+   feature: implement dark mode support
+   ```
 
-To create a breaking change (major version):
+   **Major Release** (v1.0.0 → v2.0.0):
 
-1. Create a commit that includes `BREAKING CHANGE:` or `BREAKING CHANGES:` in the commit message body and include `RELEASE`:
    ```
-   feat: redesign Button component API RELEASE
-   
+   feat: redesign Button component API
+
    BREAKING CHANGE: The Button component no longer accepts 'size' prop, use 'buttonSize' instead.
    ```
 
-2. Push your changes to the appropriate branch.
+3. **Merge your PR** to the appropriate branch:
 
-3. The semantic-release system will:
-   - Analyse your commits
-   - Detect the breaking change
-   - Increment the major version number (following semver)
+   - Merge to `dev` for prerelease versions
+   - Merge to `main` for standard releases
+
+4. The semantic-release system will automatically:
+   - Analyse the PR title and commit content
+   - Determine the appropriate version bump
    - Generate release notes
    - Publish to npm
    - Create a GitHub release
 
+#### Examples
+
+✅ **Will trigger a minor release:**
+
+- PR title: "RELEASE: Add new components"
+- Contains commit: "feat: add new Button variant"
+
+✅ **Will trigger a patch release:**
+
+- PR title: "RELEASE: Bug fixes"
+- Contains commit: "fix: resolve styling issue"
+
+✅ **Will trigger a major release:**
+
+- PR title: "RELEASE: Breaking API changes"
+- Contains commit with: "BREAKING CHANGE: removed deprecated props"
+
+❌ **Will NOT trigger any release:**
+
+- PR title: "Add new components" (missing "RELEASE")
+- Even with commits like "feat: new component"
+
 #### Manual Release
 
 If needed, you can manually trigger a release:
@@ -131,9 +165,11 @@ npm run release
 ```
 
 ## Resources 📖
+
 - [Component Examples (Storybook)](https://helix-components.cms.app.crnet.org)
 - [Full Documentation (Style guide, Theming, Testing and more)](https://super-succotash-wg8qmo1.pages.github.io/)
 - [Need help? Message us on Slack](https://cruk.slack.com/archives/C07BNR9FY4E)
 
 ## 📄 Licence
+
 MIT © Cancer Research UK

package/dist/cjs/components/Link/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../../src/components/Link/index.tsx"],"sourcesContent":[null],"names":["getIconFromFileType","pdf","PdfIcon","default","Inline","forwardRef","props","ref","variant","linkIcon","children","rest","_jsx","jsx","ChakraLink","size","base","lg","_jsxs","jsxs","Flex","alignItems","Icon","as","mr","boxSize","Footer","File","fileType","entryType","fileSize","FileIcon","_Fragment","Fragment","Text","ml","color","toUpperCase","Link","target","restProps","linkContents","linkTitle","title","linkProps","rel","undefined"],"mappings":"mJAsCA,MAAMA,EAAoC,CACxCC,IAAKC,EAAOC,SAGRC,EAASC,EAAUA,YAAiB,CAACC,EAAOC,KAChD,MAAMC,QAAEA,EAAOC,SAAEA,EAAQC,SAAEA,KAAaC,GAASL,EACjD,OACEM,EAAAC,IAACC,OAAU,CACTC,KAAM,CAAEC,KAAM,KAAMC,GAAI,MACxBV,IAAKA,KACDI,EACJH,QAASA,EAAOE,SAGfD,EACCS,EAACC,KAAAC,QAAKC,WAAYf,EAAMe,YAAc,aAAYX,SAAA,CAChDE,MAACU,EAAAA,KAAI,CAAA,cAAa,OAAOC,GAAId,EAAUe,GAAI,EAAGC,QAAS,IACvDb,EAAAA,IAAO,OAAA,CAAAF,SAAAA,UAKA,IAIXgB,EAASrB,EAAUA,YAAiB,CAACC,EAAOC,IAChDK,EAACC,IAAAC,OAAW,CAAAP,IAAKA,KAASD,MAGtBqB,EAAOtB,EAAUA,YAAqB,CAACC,EAAOC,KAClD,MAAMqB,SAAEA,EAAQC,UAAEA,EAASC,SAAEA,EAAQpB,SAAEA,KAAaC,GAASL,EACvDyB,EAAW/B,EAAoB4B,GACrC,OACEV,EACEC,KAAAa,EAAAC,SAAA,CAAAvB,SAAA,CAAAQ,EAAAA,KAACJ,EAAAA,KAAW,CAAAC,KAAM,CAAEC,KAAM,KAAMC,GAAI,MAAQV,IAAKA,KAASI,YACzC,0BAAdkB,GAAyCE,GACxCnB,EAAAC,IAACkB,EAAQ,CAACP,GAAG,kBAAgB,SAE9Bd,KAEFkB,GACCV,EAAAA,KAACgB,EAAAA,KAAI,CAACX,GAAG,OAAOY,GAAG,IAAIC,MAAM,6BACzBR,GAAUS,cACXP,EAAW,KAAKA,EAASO,gBAAkB,YAG/C,IAIDC,EAAOjC,EAAUA,YAAuB,CAACC,EAAOC,KACpD,MAAMgC,OAAEA,EAAM/B,QAAEA,KAAYgC,GAAclC,EACpCmC,EACsB,iBAAnBnC,EAAMI,SAAwBJ,EAAMI,SAAW,OAClDgC,EAAYpC,EAAMqC,OAASF,EAI3BG,EAAY,IACbJ,EACHG,MAJW,WAAXJ,EAAsB,GAAGG,yBAAmCA,EAK5DnC,MACAC,UACA+B,SACA,mBAAoB/B,EACpBqC,IAAgB,WAAXN,EAAsB,2BAAwBO,GAGrD,OAAQtC,GACN,IAAK,OACH,OAAOI,MAACe,EAAS,IAAAiB,IACnB,IAAK,SACH,OAAOhC,MAACc,EAAW,IAAAkB,IACrB,QACE,OAAOhC,MAACR,EAAW,IAAAwC"}
+{"version":3,"file":"index.js","sources":["../../../../src/components/Link/index.tsx"],"sourcesContent":[null],"names":["getIconFromFileType","pdf","PdfIcon","default","Inline","forwardRef","props","ref","variant","linkIcon","children","rest","_jsx","jsx","ChakraLink","size","base","lg","_jsxs","jsxs","Flex","alignItems","Icon","as","mr","boxSize","Footer","File","fileType","entryType","fileSize","FileIcon","_Fragment","Fragment","Text","ml","color","toUpperCase","Link","target","restProps","linkContents","linkTitle","title","linkProps","rel","undefined"],"mappings":"mJAsCA,MAAMA,EAAoC,CACxCC,IAAKC,EAAOC,SAGRC,EAASC,EAAUA,YAAiB,CAACC,EAAOC,KAChD,MAAMC,QAAEA,EAAOC,SAAEA,EAAQC,SAAEA,KAAaC,GAASL,EACjD,OACEM,EAAAC,IAACC,OAAU,CACTC,KAAM,CAAEC,KAAM,KAAMC,GAAI,MACxBV,IAAKA,KACDI,EACJH,QAASA,EAAOE,SAGfD,EACCS,EAACC,KAAAC,QAAKC,WAAYf,EAAMe,YAAc,aAAYX,SAAA,CAChDE,MAACU,EAAAA,KAAI,CAAA,cAAa,OAAOC,GAAId,EAAUe,GAAI,EAAGC,QAAS,IACvDb,EAAAA,IAAO,OAAA,CAAAF,SAAAA,UAKA,IAIXgB,EAASrB,EAAUA,YAAiB,CAACC,EAAOC,IAChDK,EAACC,IAAAC,OAAW,CAAAP,IAAKA,KAASD,MAGtBqB,EAAOtB,EAAUA,YAAqB,CAACC,EAAOC,KAClD,MAAMqB,SAAEA,EAAQC,UAAEA,EAASC,SAAEA,EAAQpB,SAAEA,KAAaC,GAASL,EACvDyB,EAAW/B,EAAoB4B,GACrC,OACEV,EACEC,KAAAa,EAAAC,SAAA,CAAAvB,SAAA,CAAAQ,EAAAA,KAACJ,EAAAA,KAAW,CAAAC,KAAM,CAAEC,KAAM,KAAMC,GAAI,MAAQV,IAAKA,KAASI,YACzC,0BAAdkB,GAAyCE,GACxCnB,EAAAC,IAACkB,EAAQ,CAACP,GAAG,kBAAgB,SAE9Bd,KAEFkB,GACCV,EAAAA,KAACgB,EAAAA,KAAI,CAACX,GAAG,OAAOY,GAAG,IAAIC,MAAM,6BACzBR,GAAUS,cACXP,EAAW,KAAKA,EAASO,gBAAkB,YAG/C,IAIDC,EAAOjC,EAAUA,YAA2B,CAACC,EAAOC,KACxD,MAAMgC,OAAEA,EAAM/B,QAAEA,KAAYgC,GAAclC,EACpCmC,EACsB,iBAAnBnC,EAAMI,SAAwBJ,EAAMI,SAAW,OAClDgC,EAAYpC,EAAMqC,OAASF,EAI3BG,EAAY,IACbJ,EACHG,MAJW,WAAXJ,EAAsB,GAAGG,yBAAmCA,EAK5DnC,MACAC,UACA+B,SACA,mBAAoB/B,EACpBqC,IAAgB,WAAXN,EAAsB,2BAAwBO,GAGrD,OAAQtC,GACN,IAAK,OACH,OAAOI,MAACe,EAAS,IAAAiB,IACnB,IAAK,SACH,OAAOhC,MAACc,EAAW,IAAAkB,IACrB,QACE,OAAOhC,MAACR,EAAW,IAAAwC"}

package/dist/esm/components/Link/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../../src/components/Link/index.tsx"],"sourcesContent":[null],"names":["getIconFromFileType","pdf","PdfIcon","Inline","forwardRef","props","ref","variant","linkIcon","children","rest","_jsx","ChakraLink","size","base","lg","_jsxs","Flex","alignItems","Icon","as","mr","boxSize","Footer","File","fileType","entryType","fileSize","FileIcon","_Fragment","Text","ml","color","toUpperCase","Link","target","restProps","linkContents","linkTitle","title","linkProps","rel","undefined"],"mappings":"uQAsCA,MAAMA,EAAoC,CACxCC,IAAKC,GAGDC,EAASC,GAA2B,CAACC,EAAOC,KAChD,MAAMC,QAAEA,EAAOC,SAAEA,EAAQC,SAAEA,KAAaC,GAASL,EACjD,OACEM,EAACC,EAAU,CACTC,KAAM,CAAEC,KAAM,KAAMC,GAAI,MACxBT,IAAKA,KACDI,EACJH,QAASA,EAAOE,SAGfD,EACCQ,EAACC,GAAKC,WAAYb,EAAMa,YAAc,aAAYT,SAAA,CAChDE,EAACQ,EAAI,CAAA,cAAa,OAAOC,GAAIZ,EAAUa,GAAI,EAAGC,QAAS,IACvDX,EAAO,OAAA,CAAAF,SAAAA,UAKA,IAIXc,EAASnB,GAA2B,CAACC,EAAOC,IAChDK,EAACC,EAAW,CAAAN,IAAKA,KAASD,MAGtBmB,EAAOpB,GAA+B,CAACC,EAAOC,KAClD,MAAMmB,SAAEA,EAAQC,UAAEA,EAASC,SAAEA,EAAQlB,SAAEA,KAAaC,GAASL,EACvDuB,EAAW5B,EAAoByB,GACrC,OACET,EACEa,EAAA,CAAApB,SAAA,CAAAO,EAACJ,EAAW,CAAAC,KAAM,CAAEC,KAAM,KAAMC,GAAI,MAAQT,IAAKA,KAASI,YACzC,0BAAdgB,GAAyCE,GACxCjB,EAACiB,EAAQ,CAACP,GAAG,kBAAgB,SAE9BZ,KAEFgB,GACCT,EAACc,EAAI,CAACV,GAAG,OAAOW,GAAG,IAAIC,MAAM,6BACzBP,GAAUQ,cACXN,EAAW,KAAKA,EAASM,gBAAkB,YAG/C,IAIDC,EAAO9B,GAAiC,CAACC,EAAOC,KACpD,MAAM6B,OAAEA,EAAM5B,QAAEA,KAAY6B,GAAc/B,EACpCgC,EACsB,iBAAnBhC,EAAMI,SAAwBJ,EAAMI,SAAW,OAClD6B,EAAYjC,EAAMkC,OAASF,EAI3BG,EAAY,IACbJ,EACHG,MAJW,WAAXJ,EAAsB,GAAGG,yBAAmCA,EAK5DhC,MACAC,UACA4B,SACA,mBAAoB5B,EACpBkC,IAAgB,WAAXN,EAAsB,2BAAwBO,GAGrD,OAAQnC,GACN,IAAK,OACH,OAAOI,EAACa,EAAS,IAAAgB,IACnB,IAAK,SACH,OAAO7B,EAACY,EAAW,IAAAiB,IACrB,QACE,OAAO7B,EAACR,EAAW,IAAAqC"}
+{"version":3,"file":"index.js","sources":["../../../../src/components/Link/index.tsx"],"sourcesContent":[null],"names":["getIconFromFileType","pdf","PdfIcon","Inline","forwardRef","props","ref","variant","linkIcon","children","rest","_jsx","ChakraLink","size","base","lg","_jsxs","Flex","alignItems","Icon","as","mr","boxSize","Footer","File","fileType","entryType","fileSize","FileIcon","_Fragment","Text","ml","color","toUpperCase","Link","target","restProps","linkContents","linkTitle","title","linkProps","rel","undefined"],"mappings":"uQAsCA,MAAMA,EAAoC,CACxCC,IAAKC,GAGDC,EAASC,GAA2B,CAACC,EAAOC,KAChD,MAAMC,QAAEA,EAAOC,SAAEA,EAAQC,SAAEA,KAAaC,GAASL,EACjD,OACEM,EAACC,EAAU,CACTC,KAAM,CAAEC,KAAM,KAAMC,GAAI,MACxBT,IAAKA,KACDI,EACJH,QAASA,EAAOE,SAGfD,EACCQ,EAACC,GAAKC,WAAYb,EAAMa,YAAc,aAAYT,SAAA,CAChDE,EAACQ,EAAI,CAAA,cAAa,OAAOC,GAAIZ,EAAUa,GAAI,EAAGC,QAAS,IACvDX,EAAO,OAAA,CAAAF,SAAAA,UAKA,IAIXc,EAASnB,GAA2B,CAACC,EAAOC,IAChDK,EAACC,EAAW,CAAAN,IAAKA,KAASD,MAGtBmB,EAAOpB,GAA+B,CAACC,EAAOC,KAClD,MAAMmB,SAAEA,EAAQC,UAAEA,EAASC,SAAEA,EAAQlB,SAAEA,KAAaC,GAASL,EACvDuB,EAAW5B,EAAoByB,GACrC,OACET,EACEa,EAAA,CAAApB,SAAA,CAAAO,EAACJ,EAAW,CAAAC,KAAM,CAAEC,KAAM,KAAMC,GAAI,MAAQT,IAAKA,KAASI,YACzC,0BAAdgB,GAAyCE,GACxCjB,EAACiB,EAAQ,CAACP,GAAG,kBAAgB,SAE9BZ,KAEFgB,GACCT,EAACc,EAAI,CAACV,GAAG,OAAOW,GAAG,IAAIC,MAAM,6BACzBP,GAAUQ,cACXN,EAAW,KAAKA,EAASM,gBAAkB,YAG/C,IAIDC,EAAO9B,GAAqC,CAACC,EAAOC,KACxD,MAAM6B,OAAEA,EAAM5B,QAAEA,KAAY6B,GAAc/B,EACpCgC,EACsB,iBAAnBhC,EAAMI,SAAwBJ,EAAMI,SAAW,OAClD6B,EAAYjC,EAAMkC,OAASF,EAI3BG,EAAY,IACbJ,EACHG,MAJW,WAAXJ,EAAsB,GAAGG,yBAAmCA,EAK5DhC,MACAC,UACA4B,SACA,mBAAoB5B,EACpBkC,IAAgB,WAAXN,EAAsB,2BAAwBO,GAGrD,OAAQnC,GACN,IAAK,OACH,OAAOI,EAACa,EAAS,IAAAgB,IACnB,IAAK,SACH,OAAO7B,EAACY,EAAW,IAAAiB,IACrB,QACE,OAAO7B,EAACR,EAAW,IAAAqC"}

package/dist/index.d.ts

@@ -106,7 +106,12 @@ interface LinkProps extends LinkProps$1 {
     variant?: LinkVariants;
     linkIcon?: ComponentWithAs<"svg", IconProps$1>;
 }
-declare const Link: ComponentWithAs<"a" | "p", LinkProps>;
+interface FileLinkProps extends LinkProps {
+    entryType?: string;
+    fileType?: string;
+    fileSize?: string;
+}
+declare const Link: ComponentWithAs<"a" | "p", FileLinkProps>;
 
 type CardProps = CardProps$1 & {
     image?: ImageProps$1;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cruk/chakra-components",
-  "version": "3.0.1",
+  "version": "3.0.3",
   "description": "Chakra UI v2 based components for CRUK applications",
   "license": "MIT",
   "sideEffects": false,