# ACPaaS UI - Angular Components [![acpaas-ui-angular-build]][acpaas-ui-angular-travis] [![ngx-components-status]][ngx-components-package] ## Introduction Antwerp City Platform as a Service User Interface (ACPaas 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 [ACPaaS UI][acpaas-ui]. | Name | Framework | Status | | ----------------- | ---------- | ------- | | Schematics | ES5+ | [![acpaas-ui-schematics-github]][acpaas-ui-schematics] | | Javascript | ES5+ | [![acpaas-ui-js-github]][acpaas-ui-js] | | Angular | Angular 6+ | [![acpaas-ui-angular-github]][acpaas-ui-angular] | | React | React 16+ | [![acpaas-ui-react-github]][acpaas-ui-react] | ## Getting Started ### Building packages The following will build `` and its example. ```sh example= npm run build:package ``` For example: ```sh example=forms npm run build:package ``` Start a new Angular app. ```sh npm install -g @angular/cli ng new my-app --style=scss cd my-app npm install @acpaas-ui/ngx-components ``` Edit styles.scss to import the branding look & feel. ```scss @import url('https://cdn.antwerpen.be/core_branding_scss/4.0.0/main.min.css'); ``` You can also modify `index.html` to reference the [favicons for the city of Antwerp][branding-favicons]. Then start using the components in your pages. Look at the component documentation below to learn how to use each component. You can also add a branding-compatible [flexbox grid layout system][flexboxgrid]: ```scss @import url('https://cdn.antwerpen.be/core_flexboxgrid_scss/1.0.1/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][branding-core-guide]. Note that the [core branding][branding-core] 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][branding-acpaas] instead. ## Documentation Check out our [live examples][acpaas-ui-angular-styleguide] or visit the [ACPaaS UI site][acpaas-ui]. This library contains the following components: | Name | Description | URL | | -------------- | ---------------------------------------- | --------------------------------------------------------- | | agenda | Calendar to display events | [Documentation](./packages/agenda/lib/README.md) | | analytics | Google Analytics integration | [Documentation](./packages/analytics/lib/README.md) | | avatar | User avatar icon | [Documentation](./packages/avatar/lib/README.md) | | calendar | Calendar to select dates | [Documentation](./packages/calendar/lib/README.md) | | code-snippet | Snippet of source code | [Documentation](./packages/code-snippet/lib/README.md) | | context | Set meta tags for SEO | [Documentation](./packages/context/lib/README.md) | | flyout | Reveal additional content | [Documentation](./packages/flyout/lib/README.md) | | forms | Assorted form fields | [Documentation](./packages/forms/lib/README.md) | | layout | Assorted page layout components | [Documentation](./packages/layout/lib/README.md) | | localstorage | Interface with localstorage | [Documentation](./packages/localstorage/lib/README.md) | | logo | Logo icon | [Documentation](./packages/logo/lib/README.md) | | map | Leaflet-based map | [Documentation](./packages/map/lib/README.md) | | notifications | Show user notifications | [Documentation](./packages/notifications/lib/README.md) | | pagination | Pagination control | [Documentation](./packages/pagination/lib/README.md) | | progress-bar | Progress bar control | [Documentation](./packages/progress-bar/lib/README.md) | | selectable-list| List control with selectable items | [Documentation](./packages/selectable-list/lib/README.md) | | table | Interactive table | [Documentation](./packages/table/lib/README.md) | | utils | Assorted helpers | [Documentation](./packages/utils/lib/README.md) | | user-menu | User Menu providing login/logout | [Documentation](./packages/user-menu/README.md) | | navigation-menu| Generic navigation menu | [Documentation](./packages/navigation-menu/README.md) ## Testing ### Test automation If you want to start automating your tests, you can have a look at our [Test Automation Guide](./TEST_AUTOMATION.md) for some tips on how to use data-attributes to keep your tests stable and maintainable. ### Cross Browser Testing We are using [Browserstack Live](https://www.browserstack.com/live) to make sure that our components work correctly on all major browsers and platforms.
The people at Browserstack kindly offer an unlimited testing program, free of charge for open source projects so a big thanks to them! Browserstack logo ## Questions For questions and support please ask a question on the [#acpaas-ui slack channel][acpaas-ui-slack]. If you're not yet a member of our DigAnt Café slack community, you can easily [join here](https://digantcafe-slack.digipolis.be). If you stumble across a bug or missing feature, feel free to [report an issue][acpaas-ui-angular-issues]. Please fill out the issue template completely when [opening an issue][acpaas-ui-angular-issues]. This will help us get to your issue sooner. ## Changelog Detailed changes for each release are documented in the [changelog](./CHANGELOG.md). ## 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](./CONTRIBUTING.md) before making a pull request. Thank you to all the people [who already contributed][acpaas-ui-angular-contributors] to ACPaaS UI! ## License [MIT](./LICENSE.md) Copyright (c) 2016-present, Digipolis [acpaas-ui]: https://acpaas-ui.digipolis.be [acpaas-ui-slack]: https://digantcafe.slack.com/messages/CDDLYJU65/ [flexboxgrid]: https://github.com/a-ui/core_flexboxgrid_scss [acpaas-ui-angular-build]: https://img.shields.io/travis/digipolisantwerp/acpaas-ui_angular.svg [acpaas-ui-angular-travis]: https://travis-ci.org/digipolisantwerp/acpaas-ui_angular [acpaas-ui-schematics]: https://github.com/digipolisantwerp/acpaas-ui_schematics [acpaas-ui-js]: https://github.com/digipolisantwerp/acpaas-ui_js [acpaas-ui-angular]: https://github.com/digipolisantwerp/acpaas-ui_angular [acpaas-ui-angular-styleguide]: https://digipolisantwerp.github.io/acpaas-ui_angular [acpaas-ui-angular-issues]: https://github.com/digipolisantwerp/acpaas-ui_angular/issues [acpaas-ui-angular-contributors]: https://github.com/digipolisantwerp/acpaas-ui_angular/graphs/contributors [acpaas-ui-react]: https://github.com/digipolisantwerp/acpaas-ui_react [branding-core]: https://github.com/a-ui/core_branding_scss [branding-core-guide]: https://a-ui.github.io/core_branding_scss/ [branding-acpaas]: https://github.com/a-ui/acpaas_branding_scss [branding-favicons]: https://github.com/a-ui/core_branding_favicons [acpaas-ui-schematics-github]: https://img.shields.io/github/package-json/v/digipolisantwerp/acpaas-ui_schematics.svg [acpaas-ui-angular-github]: https://img.shields.io/github/package-json/v/digipolisantwerp/acpaas-ui_angular.svg [acpaas-ui-js-github]: https://img.shields.io/github/package-json/v/digipolisantwerp/acpaas-ui_js.svg [acpaas-ui-react-github]: https://img.shields.io/github/package-json/v/digipolisantwerp/acpaas-ui_react.svg [ngx-components-package]: https://www.npmjs.com/package/@acpaas-ui/ngx-components [ngx-components-status]: https://img.shields.io/npm/v/@acpaas-ui/ngx-components.svg