Needless Patchouli Manufacture

    @adc/forms
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    @adc/forms

    npm (scoped) npm GitHub

    This is a collection of standalone Web Components that make it easier to work with forms, including generating them programmatically. You can use the components inside any modern JS framework or with no framework at all.

    @adc/forms is part of the aide-de-camp Web Components collection.

    How to install

    You can either:

    • install the npm package with npm install @adc/forms
    • rely on unpkg.com and a good ol' <script> tag

    How to use

    Framework-less

    <!DOCTYPE html>
    <html lang="en">
      <head>
        <script src="https://unpkg.com/@adc/forms/latest/dist/adc-forms.js"></script>
        <!-- or use the path to your node_modules folder if you are using npm -->
      </head>
      <body>
        <!-- The @adc/forms Web Components are now ready to be used. -->
        <!-- Please refer to the Component Catalog section below -->
      </body>
    </html>

    Alternatively, if you want to take advantage of ES Modules, you could include the components using an import statement.

    <!DOCTYPE html>
    <html lang="en">
      <head>
        <script type="module">
          import { defineCustomElements } from 'https://unpkg.com/adc/forms/latest/dist/esm/es2017/adc-forms.define.js';
          // or use the path to your node_modules folder if you are using npm
          defineCustomElements(window);
        </script>
      </head>
      <body>
        <!-- The @adc/forms Web Components are now ready to be used. -->
        <!-- Please refer to the Component Catalog section below -->
      </body>
    </html>

    Angular

    Including the Custom Elements Schema

    Including theCUSTOM_ELEMENTS_SCHEMA in the module allows the use of the web components in the HTML markup without the compiler producing errors. Here is an example of adding it to AppModule:

    import { BrowserModule } from '@angular/platform-browser';
    import { CUSTOM_ELEMENTS_SCHEMA, NgModule } from '@angular/core';
    import { FormsModule } from '@angular/forms';
    
    import { AppComponent } from './app.component';
    import { SharedModule } from './shared/shared.module';
    
    @NgModule({
      declarations: [AppComponent],
      imports: [BrowserModule, FormsModule, SharedModule],
      bootstrap: [AppComponent],
      schemas: [CUSTOM_ELEMENTS_SCHEMA],
    })
    export class AppModule {}

    The CUSTOM_ELEMENTS_SCHEMA needs to be included in any module that uses custom elements.

    Calling defineCustomElements

    A component collection built with Stencil (such as this one) includes a main function that is used to load the components in the collection. That function is called defineCustomElements() and it needs to be called once during the bootstrapping of your application. One convenient place to do this is in main.ts as such:

    import { enableProdMode } from '@angular/core';
    import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
    
    import { AppModule } from './app/app.module';
    import { environment } from './environments/environment';
    
    import { defineCustomElements } from '@adc/forms/dist/loader';
    
    if (environment.production) {
      enableProdMode();
    }
    
    platformBrowserDynamic()
      .bootstrapModule(AppModule)
      .catch(err => console.log(err));
    defineCustomElements(window);

    React

    With an application built using the create-react-app starter the easiest way to include the component library is to call defineCustomElements(window) from the index.js file.

    import React from 'react';
    import ReactDOM from 'react-dom';
    import './index.css';
    import App from './App';
    import registerServiceWorker from './registerServiceWorker';
    
    import { defineCustomElements } from '@adc/forms/dist/loader';
    
    ReactDOM.render(<App />, document.getElementById('root'));
    registerServiceWorker();
    defineCustomElements(window);

    Vue.js

    In order to use the custom element library within the Vue app, the application must be modified to define the custom elements and to inform the Vue compiler which elements to ignore during compilation. This can all be done within the main.js file. For example (assuming you created your project with vue-cli):

    import Vue from 'vue';
    import App from './App.vue';
    import { defineCustomElements } from '@adc/forms/dist/loader';
    
    Vue.config.productionTip = false;
    Vue.config.ignoredElements = [/adc-forms-\w*/];
    
    defineCustomElements(window);
    
    new Vue({
      render: h => h(App),
    }).$mount('#app');

    Component Catalog

    Browser support

    • Chrome (and all Chromium based browsers)
    • Safari
    • Edge
    • Firefox (64+ only)

    Web Components, specifically Custom Elements, are natively supported in Chrome and Safari and are coming to both Edge and Firefox. A dynamic polyfill loader is already included in order to only load the polyfills for the browsers that are missing specific features.

    Install

    npm i @adc/forms

    DownloadsWeekly Downloads

    3

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    244 kB

    Total Files

    45

    Last publish

    Collaborators

    • davguij