npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tylertech/forge-angular

v5.0.0

Published

Forge components adapter library for Angular

Downloads

308

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

kieran.nicholskieran.nicholsryan.sheehanryan.sheehanjcnjcnsamrichardsonsamrichardsonnick.andrewsnick.andrewstylerdevopstylerdevops

Keywords

Readme

Forge Angular

An Angular adapter library for the Tyler Forge™ Web Components library.

Problem

Web Components, more specifically custom elements are not compatible with Angular by default. This requires us to use CUSTOM_ELEMENTS_SCHEMA within our Angular modules to tell Angular not to throw errors when it comes across an HTML element that it doesn't recognize. The problem with this is that we lose some type safety and useful error messages with these elements as we're developing.

Solution

The purpose of this library is to make using Forge Web Components in Angular a seamless experience. It provides ControlValueAccessor directives to enable usage of constructs like formControlName, formControl, and ngModel, as well as auto-generated proxy (wrapper) components for every <forge-*> element in the Forge component library.

To elaborate on the proxy components, these are Angular components that target the element names for every Forge custom HTML element. This allows Angular to provide strict type safety for properties and events as well as intelligent code completion and useful error messages. Each component is exported from its own Angular module to allow for opting in to include only specific components that your Angular application is using.

This enables developers to be able to remove their usage of CUSTOM_ELEMENTS_SCHEMA when using Forge.

Version Compatibility

| @tylertech/forge-angular | Angular | Forge | | -------------------------- | ------------------- | -------- | | ^5.0.0 | >=18.0.0 < 20.0.0 | ^3.0.0 | | ^4.0.0 | >=17.0.0 < 19.0.0 | ^3.0.0 | | ^3.0.0 | >=16.0.0 < 18.0.0 | ^2.0.0 | | ^2.0.0 | >=13.3.0 < 16.0.0 | ^2.0.0 |

Getting started

While this library is not required to use Forge with Angular, it is highly recommended. Follow these steps to get started:

  1. Install the latest version of Forge components: npm install @tylertech/forge
    • This is the library that contains the framework-agnostic Web Components.
  2. Install the latest version of this Forge Angular adapter library using the version compatibility table above: npm install @tylertech/forge-angular
  3. Reference the Forge global stylesheet in your styles.scss file: @use '@tylertech/forge/dist/forge.css';
    • You can also include this file through the angular.json file if desired as well.
  4. Add the forge-typography class to your <body> element in index.html.
    • This sets up the Forge typography across your application.
  5. To use a Forge component, you will import the Angular module from @tylertech/forge-angular for each component you are using. Ex. ForgeButtonModule
    • This tells Angular about each Forge component you are using, and allows for strict typing that you wouldn't normally get without this library.