Skip to content

cambiph/webcomponent-vl-ui-button

 
 

Repository files navigation

vl-ui-button

GitHub issues GitHub pull requests GitHub release (latest SemVer)

Een button laat de gebruiker toe om een bepaalde actie uit te voeren. Welke soort actie dat is, staat aangegeven op de button in de vorm van een tekst of een icoon.

Installatie

$ npm install --save vl-ui-button

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 testen die bij elke commit geautomatiseerd in Chrome en Firefox draaien. Hierdoor kunnen we bij elke release een minimum aan kwaliteit garanderen. Later zullen er ook nog UI testen toegevoegd worden zodat al de functionaliteit uitgebreid getest wordt.

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 zodat de bug opgelost kan worden
  2. Elke commit die betrekking heeft tot een issue moet een verwijzing hiernaar hebben vb. #33 fix uitlijning header
  3. Elke PR moet een issue verwijzing hebben, zodat deze automatisch opgenomen kan worden 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 [email protected].

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 77.7%
  • HTML 18.0%
  • CSS 4.3%