Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Technical debt] Migration to ng-icons #1020

Merged
merged 11 commits into from
Oct 25, 2024
Merged

[Technical debt] Migration to ng-icons #1020

merged 11 commits into from
Oct 25, 2024

Conversation

cmoinier
Copy link
Collaborator

@cmoinier cmoinier commented Oct 17, 2024

Description

This PR migrates all apps icons from mat-icon to ng-icon (and various fixes found along the way).

Notes :

  • All icons except for the editor's are still based on Google material, exceptionally on tabler-icons, which were better suited on some occasions.
  • To fit the mockups, the editor icons are based on Iconoir.
  • For "conditional icons" (eg : icon names passed as inputs into a component), the icon in question must be imported in the module / component where it's rendered.
  • Added missing translations
  • Fixed record preview feed story
  • Removed import.cy e2e file because its tests belong in the record-actions e2e file.

Architectural changes

Added the ng-icons library, as well as "ng-icons/material-icons", "ng-icons/tabler-icons", and "ng-icons/iconoir".

Quality Assurance Checklist

  • Commit history is devoid of any merge commits and readable to facilitate reviews
  • If new logic ⚙️ is introduced: unit tests were added
  • If new user stories 🤏 are introduced: E2E tests were added
  • If new UI components 🕹️ are introduced: corresponding stories in Storybook were created
  • If breaking changes 🪚 are introduced: add the breaking change label
  • If bugs 🐞 are fixed: add the backport <release branch> label
  • The documentation website 📚 has received the love it deserves

@cmoinier cmoinier changed the title Migration to ng-icons [Technical debt] Migration to ng-icons Oct 17, 2024
Copy link
Contributor

github-actions bot commented Oct 17, 2024

Affected libs: feature-dataviz, feature-record, feature-router, feature-editor, feature-map, feature-search, ui-catalog, feature-catalog, ui-dataviz, ui-search, ui-elements, feature-notifications, ui-inputs, ui-layout, ui-map, ui-widgets, database-dump, data-access-datafeeder, api-metadata-converter, api-repository, feature-auth, util-data-fetcher, data-access-gn4, util-app-config, common-fixtures, util-shared, common-domain, util-i18n,
Affected apps: datafeeder, datahub, metadata-converter, metadata-editor, webcomponents, demo, search, map-viewer, data-platform,

  • 🚀 Build and deploy storybook and demo on GitHub Pages
  • 📦 Build and push affected docker images

Copy link
Contributor

github-actions bot commented Oct 17, 2024

📷 Screenshots are here!

Copy link
Collaborator

@jahow jahow left a comment

Choose a reason for hiding this comment

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

Thank you!! very impressive work!! I've tested several pages randomly and couldn't find any issues. I wrote down a few remarks in the code, I feel like this PR highlights very much the need for us to have exclusively standalone components, since importing icons becomes very cumbersome otherwise.

Also I think there's a new mat-icon that snuck in there since the branch was rebased on main :)

I'm looking at the test failures now, it seems like a very deep issue, will report there if I find something

apps/datahub/src/app/app.module.ts Show resolved Hide resolved
tailwind.base.css Outdated Show resolved Hide resolved
@coveralls
Copy link

coveralls commented Oct 24, 2024

Coverage Status

coverage: 83.947% (+0.4%) from 83.538%
when pulling 66c9447 on migrate-ng-icons
into f246d6b on main.

That fixed a weird issue where ogc-client would apply polyfills on the node
global scope, making some tests fail
@cmoinier cmoinier merged commit dbb45b4 into main Oct 25, 2024
13 checks passed
@cmoinier cmoinier deleted the migrate-ng-icons branch October 25, 2024 10:03
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