icons: enhanced React SVG component support

blackfalcon commented 1 month ago

Is your feature request related to a problem? Please describe.

The current documented React solution is no longer valid. The recommended path for using icons directly with a React project require a few manual steps and then this even get's more complicated when using Typescript.

Describe the solution you'd like

All current React use documentation should be removed.

Suggested updates are related to the work required to refactor this project;

https://github.com/Alaska-ECommerce/SeatsUI/pull/593/files

One recommendation is to auto-generate a JS file that reads all the icons in the directory and generates lines of code as seen in this example based off a template.

import { ReactComponent as SeatStroke } from "@alaskaairux/icons/dist/icons/in-flight/seat-stroke.svg";
import { ReactComponent as FirstClassLegroom } from "@alaskaairux/icons/dist/icons/in-flight/first-class-legroom.svg";
import { ReactComponent as WineAndSpiritsStroke } from "@alaskaairux/icons/dist/icons/in-flight/wine-and-spirits-stroke.svg";

In addition to this auto-generated file, updated documentation needs to be added to the README file that includes the setup and install instructions and examples like the following:

import { ErrorFilled, InformationFilled } from '@alaskaairux/icons/dist/reactComponents.js';

With this markup

<div>
  <ErrorFilled />
  <InformationFilled />
</div>

Describe alternatives you've considered

Making people do the work themselves.

Additional context

This work was inspired by working with @ashleybiermannalaska to refactor the SeatsUI due to issues discovered with using auro-icon and its CDN dependency in newer mobile experiences. https://github.com/Alaska-ECommerce/SeatsUI/pull/593/files

Exit criteria

This issue can be closed once there is a useable export file added to the project for React users to consume.

Once completed, a new issue should be created to address any additional TS support needed that could be automated and included into the Icons project.

jason-capsule42 commented 1 month ago

After reviewing this PR and working with Ashley B on the Seats team to understand their needs a little more I now have a better grasp on what problems this ticket and attached PR address.

In short, importing and using SVG files in React is a P.I.T.A. due to hurdles that are unique to React. @blackfalcon's PR demonstrates a method for taking that burden off the consumer teams by generating JS wrappers for each icon that are easier for teams like Seats to import and use in their React code.

Since this is not just a simple bug fix, I am moving this ticket back to Triage so that the Auro Team as a whole can review the feature add and make a team decision regarding it's implementation.

For my part, I see this as a nice feature add and I think we should move forward with this solution.

Nice work and thanks for helping out, @blackfalcon!

jason-capsule42 commented 1 month ago

Moving this to blocked while I explore a similar alternative called SVGR.

https://github.com/AlaskaAirlines/Icons/issues/268

blackfalcon commented 1 month ago

Hey @jason-capsule42,

I'd like to get your thoughts on using the SVGR-CLI in the workflow. With this PR the README includes SVGR as part of the project's suggested Webpack configuration, which simplifies the process by eliminating the need to update each individual icon.

The changes to the generate script only focuses on creating the necessary import statements for React, such as:

import { ReactComponent as Instagram } from "...";

From there, the @svgr/webpack loader manages the rest during the Webpack build, allowing users to directly reference the icons they need, reducing boilerplate code. For example:

import { Instagram, InformationFilled } from '@alaskaairux/icons/dist/reactComponents.js';

Using the SVGR-CLI will generate an additional set of React-specific JavaScript files like the following:

import * as React from "react";
const SvgInstagram = (props) => (
  <svg
    xmlns="http://www.w3.org/2000/svg"
    aria-labelledby="instagram__desc"
    className="instagram_svg__ico_squareLarge"
    style={{
      minWidth: "var(--auro-size-lg, var(--ds-size-300, 1.5rem))",
      height: "var(--auro-size-lg, var(--ds-size-300, 1.5rem))",
      fill: "currentColor",
    }}
    viewBox="0 0 24 24"
    {...props}
  >
    <desc>Instagram social media icon.</desc>
    <path d="M17 3a4 4 0 0 1 4 4v10a4 4 0 0 1-4 4H7a4 4 0 0 1-4-4V7a4 4 0 0 1 4-4zm0 1.5H7A2.5 2.5 0 0 0 4.5 7v10A2.5 2.5 0 0 0 7 19.5h10a2.5 2.5 0 0 0 2.5-2.5V7A2.5 2.5 0 0 0 17 4.5M12 7a5 5 0 1 1 0 10 5 5 0 0 1 0-10m0 1.5a3.5 3.5 0 1 0 0 7 3.5 3.5 0 0 0 0-7M17 6a1 1 0 1 1 0 2 1 1 0 0 1 0-2" />
  </svg>
);
export default SvgInstagram;

One consideration is that this step would need to be incorporated after all other icon generation processes are completed, and there may be a need for further optimization to minimize the resulting JS files.

Looking forward to hearing your thoughts.

jason-capsule42 commented 1 month ago

@blackfalcon thanks for all the followup on this one. @rmenner has been working with me on this one and is going to take over this ticket from me.

Ryan, please comment here about the findings we discussed so far and what your next steps are. Thanks!

rmenner commented 1 month ago

My thoughts.

Add an additional file that contains the react transformed svg *_react.mjs
- Planning to use @svgr/core so that the transformation can take place all together.
Adjust the react import statements in the reactComponents file. (needs to include export statement)
Also need to update file extensions to mjs so it works with module based development.
Not sure if I need to make additional files to also support common js.

AlaskaAirlines / Icons