@acpaas-ui/react-components

Antwerp UI is a component interface library for building user interfaces and responsive web apps.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
1331Jun 8, 2021Jul 2, 2018Minified + gzip package size for @acpaas-ui/react-components in KB

Readme

Antwerp UI - React Components

Introduction

Antwerp City Platform as a Service User Interface (Antwerp UI) is a component interface library for building user interfaces and responsive web apps. It's designed to provide developers with functionality and UI/UX patterns that matches the Antwerpen styleguide.

Ecosystem

This library is part of Antwerp UI.

Name Framework Status
Javascript ES5+ antwerp-ui-js-github
Angular Angular 6+ antwerp-ui-angular-github
React React 16+ antwerp-ui-react-github

Getting Started

npm install @acpaas-ui/react-components

Import the core branding to style the components:

@import url("https://cdn.antwerpen.be/core_branding_scss/5.0.0/main.min.css");

You can also add a branding-compatible flexbox grid layout system:

@import url('https://cdn.antwerpen.be/core_flexboxgrid_scss/2.0.0/flexboxgrid.min.css');

Note that you are free to use your own grid, as long as it meets our branding guidelines.

To learn more about using the branding look & feel, check the core branding guide. Note that the core branding contains the Antwerp logo and fonts, which are subject to a usage restriction. For use outside of apps for the city of Antwerp you can use acpaas branding instead.

Check out the live examples and API docs to learn more.

Questions

For questions and support please ask a question on the #antwerp-ui-react slack channel. If you're not yet a member of our DigAnt Café slack community, you can easily join here.

If you stumble across a bug or missing feature, feel free to report an issue. Please fill out the issue template completely when opening an issue. This will help us get to your issue sooner.

Changelog

Detailed changes for each release are documented in the changelog.

Contributing

Your contributions are most welcome as pull requests, both code changes and documentation updates. However, to keep a high quality standard, please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Antwerp UI!

Support

Jasper Van Proeyen (jasper.vanproeyen@digipolis.be)

License

MIT

Copyright (c) 2018-present, Digipolis

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.