Skip to content

Angular Wrappers

Mark E edited this page Nov 9, 2024 · 6 revisions

Problem and outcome

Right now when Angular developers are using our components, they don't get common developer features, such as:

  • Type Safety
  • Typeahead
  • Error checking
  • Consistent names for types, properties, and events between Angular and React

This epic is being worked on in an attempt to solve these problems, and give developers access to features that are common to every framework and language they are using.

After this epic is done, developers will have:

  • Type safety for all components and events and functions related to those components
  • Typeahead suggestions in their IDE, providing clear suggestions as they type about what properties are available and even what components are available
  • Error checking on build of their application
  • Aligned Properties, Types, and Events with React Components, enabling seamless switching between Angular and React projects

By doing this work, we will be speeding up all Angular developers that are using our components, as well as giving their applications safer and more accurate builds.

High-level timeline

Design

  • Design updated documentation website

Automation and Integration

  • Writing Cypress "component" tests
  • Creating "upgrade path" documentation

Testing and Documentation

  • Manual testing Angular and React wrappers
  • Building updated documentation website

Pre-Launch and Refinement

  • Testing updated website
  • Launching for Experimental Release

Production Launch

  • Major version release communication
  • Releasing to the public

Milestones

  1. Experimental Release - a release of the wrappers to a small subset of users to help us with testing
  2. Re-development of website - a major update to the website to allow users to see documentation for older versions, as well as the new and upgraded versions of our components

Dependencies

Links to be added as Features are documented

  1. Experimental Release
  2. Website Release
  3. Support

Risk and Mitigations

Risks for product teams

  1. Slower Development Pace: Teams may experience reduced development speed as they adapt to the new components and wrappers.
  2. Codebase Refactoring: Existing codebases may need refactoring to integrate the new wrappers, requiring adjustments to timelines and project schedules.

Risks for Design System team

  1. Increased Support Load: The transition period may lead to higher support demands, potentially impacting other priorities.
  2. Time-Consuming Updates and Fixes: Early adopters might identify issues that require additional time to address.
  3. Extended Bug Fix Times: Resolving bugs may take longer if changes need to be implemented across multiple versions.
Clone this wiki locally