# @adc/date      This is a collection of standalone Web Components to easily format dates. **@adc/date** is part of the [aide-de-camp](https://github.com/aide-de-camp) Web Components collection. ## How to install You can either: - install the npm package with `npm install @adc/date` - rely on unpkg.com and a good ol' ` ``` Alternatively, if you want to take advantage of ES Modules, you could include the components using an import statement. ```html ``` ### Angular #### Including the Custom Elements Schema Including the`CUSTOM_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`: ```ts 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: ```ts 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/date/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. ```js import React from 'react'; import ReactDOM from 'react-dom'; import './index.css'; import App from './App'; import registerServiceWorker from './registerServiceWorker'; import { defineCustomElements } from '@adc/date/dist/loader'; ReactDOM.render(, 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`): ```js import Vue from 'vue'; import App from './App.vue'; import { defineCustomElements } from '@adc/date/dist/loader'; Vue.config.productionTip = false; Vue.config.ignoredElements = [/adc-date-\w*/]; defineCustomElements(window); new Vue({ render: h => h(App), }).$mount('#app'); ``` ## Component Catalog - [adc-date-ago](https://github.com/aide-de-camp/pay/tree/master/src/components/date-ago) - [adc-date-epoch](https://github.com/aide-de-camp/pay/tree/master/src/components/date-epoch) - [adc-date-relative](https://github.com/aide-de-camp/pay/tree/master/src/components/date-relative) ## Browser support - Chrome (and all Chromium based browsers) - Safari - Edge - Firefox - IE 11 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.