Skip to content

Conversation

@maxelkins
Copy link
Contributor

@maxelkins maxelkins commented Oct 17, 2025

Closes https://github.com/RaspberryPiFoundation/digital-editor-issues/issues/968

Summary

Update to the latest design system to take advantage of new components and features.

What's been done?

  • Incrementally updated - see commits
  • Ran all tests at each commit
  • Followed design system updating guide for v2+
  • Fixed any breaking changes - only 1 (see commits details)
  • Added material icon font to host (web component preview page) since the design system depends on this for some components.

Screenshots

Screenshot 2025-10-29 at 09 33 16 Screenshot 2025-10-29 at 09 33 26 Screenshot 2025-10-29 at 09 33 53

Issues to be solved in another PR

  • Some styles appear to be broken/missing
    • Note this is only when "use_editor_styles" isn't true
    • This is an existing issue.
    • There are also some issues with Design System components not looking correct. This is because editor-ui is overriding design-system-core styles via classes or global selectors (e.g. button) rather than overriding custom properties - which would normally avoid most breaking changes. Largely "core breaking component changes" only affect upstream packages (react/rails).

Suggested tasks:

  • Ensure all editor CSS custom properties have a fallback, so that a theme isn't required (Issue)
  • Migrate to using design system buttons - See PR.
  • Migrate to theming using Design System component via the CSS custom properties
Screenshot 2025-10-29 at 09 39 38

- 2.0.0 uses vite and packages core, so that dep can removed.
- Link to core style does however need to be added to the app, following the update guide for the design system.
- TextEncoder/TextDecoder was not set up in jest and this was causing some design system component to fail tests.
- No buttons using href prop so no changes needed
@maxelkins maxelkins temporarily deployed to previews/1261/merge October 17, 2025 10:18 — with GitHub Actions Inactive
@maxelkins maxelkins temporarily deployed to previews/1261/merge October 17, 2025 15:45 — with GitHub Actions Inactive
@maxelkins maxelkins mentioned this pull request Oct 17, 2025
12 tasks
@maxelkins maxelkins changed the title Update design system to v2.6.2 build: update design system to v2.6.2 Oct 21, 2025
@maxelkins maxelkins marked this pull request as ready for review October 29, 2025 09:47
@maxelkins maxelkins temporarily deployed to previews/1261/merge October 29, 2025 09:52 — with GitHub Actions Inactive
@adrian-rpf adrian-rpf requested a review from Copilot October 30, 2025 09:19
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR upgrades the design system packages from version 1.6.0 to 2.6.2, consolidating two separate packages (design-system-core and design-system-react) into a single design-system-react package that includes the core functionality.

Key changes:

  • Upgraded @raspberrypifoundation/design-system-react from 1.6.0 to 2.6.2 and removed the separate design-system-core dependency
  • Updated styling imports to use the consolidated package structure
  • Added Material Symbols font to the web component preview page
  • Added TextEncoder/TextDecoder polyfills for Jest environment
  • Fixed minor JavaScript style inconsistencies (missing semicolons)

Reviewed Changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
package.json Removed separate design-system-core dependency and pinned design-system-react to version 2.6.2
yarn.lock Updated lockfile with new package versions and dependency changes for design system packages
src/assets/stylesheets/ExternalStyles.scss Updated SCSS imports to use consolidated design-system-react package path
src/web-component.html Added Material Symbols font link and fixed missing semicolons for consistency
src/utils/setupTests.js Added TextEncoder/TextDecoder polyfills required by new design system version
CHANGELOG.md Documented the design system upgrade and Material Symbols font addition

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Also use `^` in package.json and update lock file accordingly
@maxelkins maxelkins changed the title build: update design system to v2.6.2 build: update design system to v2.7.0 Oct 30, 2025
@Mohamed-RPF
Copy link

LGTM

@maxelkins maxelkins merged commit f6f6727 into main Oct 30, 2025
8 checks passed
@maxelkins maxelkins deleted the update-design-system branch October 30, 2025 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants