@duetds/components 7.1.2 → 8.0.0

package/README.md

@@ -18,15 +18,11 @@ This package is built with [Stencil.js](http://stenciljs.com/), a compiler and t
 The following are the most commonly used commands during development:
 
 * `npm start` - Compile components, start watching for changes, start local development server
-* `ES5=true npm start` - As above, but with support for legacy browsers. Useful for testing IE11
-* `SSR=true npm start` - Enables SSR in dev server
-* `npm run build` - Build project
-* `npm test` - Run all tests once
-* `npm test:dev - Run tests with a development koa server to serve assets and act as upload target for duet-upload
-* `npm test:fixtures - Run the visuall regressions tests 
-* `npm lint:fix - Run the linters and autofix what can be autofixed
+* `npm test` - Compile components, start watching for changes, start local development server and run tests.
 
-The local development server started by `npm start` serves a file located at `/src/index.html`. Any local changes or new components are available on this page, so this can be used as a testing ground when developing.
+The local development server started by `npm start` or `npm test` serves a files located at `/src/prototypes/`. Any local changes or new components are available on this page, so this can be used as a testing ground when developing.
+
+On that page you can also press `ctrl + p` to choose any of the component fixtures to work on.
 
 ### How to develop new components
 
@@ -36,9 +32,6 @@ The local development server started by `npm start` serves a file located at `/s
     1. add `[component-name].scss`
     1. add `[component-name].e2e.ts`
     1. add `readme.md`
-1. In `stencil.config.js`
-    1. Add new component to `bundles` field of config
-    1. For input components, configure angular value accessors (see section below)
 1. Implement component
 1. Write tests
 1. Write readme
@@ -46,8 +39,6 @@ The local development server started by `npm start` serves a file located at `/s
     1. add comprehensive examples
 1. Test theming for both `default` and `turva`
 1. Browser testing
-    1. Evergreen browsers
-    1. Edge on Windows
 1. Accessibility testing, following the [Duet accessibility checklist](https://www.duetds.com/accessibility/)
 1. Test SSR
 1. Add the following to `docs/`:
@@ -64,30 +55,6 @@ The local development server started by `npm start` serves a file located at `/s
 - When working on new components or editing existing ones, make sure to follow our [code style guide](/dev-standards/) found under the guidelines section.
 - Component variation examples are inside each component’s `readme.md`, while the component templates are located under `/docs/src/templates/` directory.
 
-### How angular value accessors work
-
-Angular's [ControlValueAccessors](https://angular.io/api/forms/ControlValueAccessor) are used to adapt custom inputs to work with Angular's reactive forms. The `angular-output-target` accepts config to auto-generate value accessors for stencil components.
-
-To correctly adapt a component for Angular reactive forms, the output target must know:
-
-1. The CSS _selector_ for the component
-1. The _type_ of input (`text`, `radio`, `select`, `number`, `boolean`)
-1. The name of the _attribute_ which holds the input's value
-1. The name of the _event_ raised on change
-
-As an example, consider `duet-checkbox`:
-
-1. `duet-checkbox` is the CSS selector for this component
-1. `boolean` is the type of input component (since it is `true` when checked, `false` when unchecked)
-1. The `checked` attribute that holds the component's value
-1. The `duetChange` event is raised when the value is changed
-
-You can likely add any new components to one of the existing configs, but if not, you can simply add a new config providing all the above information.
-
-### Why use a forked version of angular output target?
-
-We originally forked `@stencil/angular-output-target` in order to add support for disabled inputs in Angular reactive forms. Whilst this feature has now landed upstream, we have not upgraded as we observed a number of compatibility issues between the `angular-output-target` and newer versions of angular.
-
 ## Copyright
 
-Copyright © 2021 LocalTapiola/Turva.
+Copyright © 2023 LocalTapiola/Turva.