milieuinfo / webcomponent-vl-ui-wizard

1 stars 0 forks source link

vl-ui-wizard

GitHub issues GitHub pull requests GitHub release (latest SemVer)

Gebruik de wizard om de gebruiker door een proces met meerdere stappen te begeleiden. Een wizard laat je toe om een complex proces op te splitsen in hapklare acties. Een wizard maakt het ook mogelijk om opties afhankelijk te maken van de keuzes in een voorgaande stap.

Installatie

$ npm install --save vl-ui-wizard

API

De API bevat een overzicht van de ondersteunde attributen en een beschrijving van de beschikbare functies.

Demo

De demo pagina bevat een overzicht van de mogelijkheden met code voorbeelden. Lokaal opstarten kan met onderstaand NPM script.

$ npm run demo

Testen

De webcomponent bevat verschillende unit en UI testen die bij elke commit geautomatiseerd in Chrome, Edge en Firefox draaien. Hierdoor kunnen we bij elke release een minimum aan kwaliteit garanderen.

De testen kunnen lokaal opgestart worden met onderstaand NPM script.

$ npm run test

Issues

Indien je nood hebt aan extra feature of een bug gevonden hebt, mag je hiervoor een issue aanmaken. Er zijn 3 issues templates beschikbaar:

  1. Feature request
  2. Bug
  3. Task

Uiteraard is het ook toegelaten om mee te ontwikkelen door gebruik te maken van Pull Requests (PR). Gelieve volgende conventies te respecteren:

  1. Bug issue best linken aan een branch met een test die het probleem illustreert
  2. Elke commit die betrekking heeft tot een issue moet een verwijzing hiernaar hebben
  3. Elke PR moet een issue verwijzing hebben, zodat deze opgenomen wordt in de release notes

Versionering

We gebruiken Semantic Versioning en voorzien elke release van release notes, zie een overzicht van de releases.

Browser ondersteuning

De webcomponenten zijn ontwikkeld door uitsluitend gebruik te maken van web standaarden (JavaScript, HTML, CSS). Hierdoor worden al de evergreen browser automatisch ondersteund.

Chrome Firefox Safari Opera Edge
Chrome
Firefox
Safari
Opera
Edge

Credits

Zie de lijst van ontwikkelaars die meegewerkt hebben aan de webcomponent.

Contact

Heb je suggesties, opmerkingen of tips? Voel je dan vrij om ons te contacteren via help@omgevingvlaanderen.be.