@raspberrypifoundation/design-system-react 2.6.0 → 2.6.1

package/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.6.1 - 2025-09-18
+
+### Changed
+
+- CheckboxInput, SearchInput, Alert, Button, Tag and ProgressBar have Typescript typing for props. (#156)
+- `Alert` props are now enforced at the type level - you cannot have `title` and `titleChildren` at the same time, nor `text` and `children`.
+
 ## 2.6.0 - 2025-09-12
 
 ### Added

package/README.md

@@ -152,6 +152,27 @@ If you are experiencing issues and believe design-system-react is not using your
 
 We've two places where the NodeJS version is specified, and we should keep these in-sync. The `.tool-versions` is used for local development, installed via `asdf`. The `.nvmrc` is used in the CI/publish Github action, and the Cloudflare pages build process. If you change one, please change t'other.
 
+## TypeScript and PropTypes
+
+This package is gradually migrating from `PropTypes` to TypeScript for type checking. `PropTypes` were deprecated in 2017 and will not be supported by React 19.
+
+### To get the best type experience:
+
+- **TypeScript consumers**  
+  - You’ll get full static type information when using the TS-enabled components (any component using the `.tsx` file extension).  
+  - Props are defined with TypeScript interfaces/types instead of `propTypes`.  
+  - No runtime validation is performed — errors are caught at compile time.  
+
+- **JavaScript consumers**  
+  - Components continue to work exactly the same.  
+  - However, you will no longer see runtime warnings in the console when passing
+    incorrect props to components that use TypeScript instead of `propTypes`.  
+  - Refer to the [Storybook](https://design-system-react.rpf-internal.org/) docs
+    or the component’s TypeScript definition for prop typing details.
+  - Consider moving to Typescript to get the most out of type definitions.
+
+During the migration period you may see a mix of `propTypes` and TypeScript in different components.
+
 ## Deployment
 
 Create a new [release](https://github.com/RaspberryPiFoundation/design-system-react/releases):