Skip to content

Commit

Permalink
Antwerp UI
Browse files Browse the repository at this point in the history
  • Loading branch information
TriangleJuice committed May 28, 2021
1 parent 4c4d391 commit bac7402
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 20 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
- `Switch` [BREAKING] Changed the way the Switch component works
- `Toggle` [BREAKING] Changed the way the Toggle component works
- `Button` [BREAKING] Removed 'alt' prop as it isn't valid
- Antwerp UI

### Fixed
- `Accordion` Improved accessibility
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# ACPaaS UI Contributing Guide
# Antwerp UI Contributing Guide

Hi! We're really excited that you are interested in contributing to ACPaaS UI. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.
Hi! We're really excited that you are interested in contributing to Antwerp UI. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.

- [ACPaaS UI Contributing Guide](#acpaas-ui-contributing-guide)
- [Antwerp UI Contributing Guide](#acpaas-ui-contributing-guide)
- [Issue Reporting Guidelines](#issue-reporting-guidelines)
- [Pull Request Guidelines](#pull-request-guidelines)
- [Development Setup](#development-setup)
Expand All @@ -17,7 +17,7 @@ Hi! We're really excited that you are interested in contributing to ACPaaS UI. B
- Use the [#acpaas-ui-react channel][acpaas-ui-react-slack] on slack to ask questions or discuss changes to the code itself.
- Use [GitHub Issues][github-issues] to report bugs, request features, ask policy questions or propose policy changes.

> Note: policy questions are about the way ACPaaS UI is developed and released, or about its architecture. We use github issues to have a public archive of these discussions.
> Note: policy questions are about the way Antwerp UI is developed and released, or about its architecture. We use github issues to have a public archive of these discussions.
## Pull Request Guidelines

Expand Down Expand Up @@ -76,7 +76,7 @@ The default test script will do the following: lint with ESLint -> unit tests wi

## Releases

ACPaaS UI is supplied as a single library on NPM [@acpaas-ui/react-components](https://www.npmjs.com/package/@acpaas-ui/react-components).
Antwerp UI is supplied as a single library on NPM [@acpaas-ui/react-components](https://www.npmjs.com/package/@acpaas-ui/react-components).

It is released once a week, or more often if there are high priority changes.

Expand All @@ -88,7 +88,7 @@ A [changelog](CHANGELOG.md) is provided for your convenience.
## Credits

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

[github-issues]: https://github.com/digipolisantwerp/acpaas-ui_react/issues
[acpaas-ui-react-slack]: https://digantcafe.slack.com/messages/CDGCW8U30/
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# ACPaaS UI - React Components
# Antwerp UI - React Components

## 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.
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 [ACPaaS UI][acpaas-ui].
This library is part of [Antwerp UI][acpaas-ui].

| Name | Framework | Status |
| ----------------- | ---------- | ------- |
Expand Down Expand Up @@ -53,7 +53,7 @@ Detailed changes for each release are documented in the [changelog](./CHANGELOG.

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-react-contributors] to ACPaaS UI!
Thank you to all the people [who already contributed][acpaas-ui-react-contributors] to Antwerp UI!

## Support

Expand Down
14 changes: 7 additions & 7 deletions TESTING.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# ACPaaS UI Testing Guide
# Antwerp UI Testing Guide

When developing, testing is a major part of the work.
We use [Jest](https://jestjs.io) in combination with [Enzyme](https://airbnb.io/enzyme) as our test suite.

To make life easier in Visual Studio Code for testing with Jest, we suggest that you install [this VS Code Jest extension](https://github.com/jest-community/vscode-jest).

## ACPaaS UI Test Automation Guide
## Antwerp UI Test Automation Guide

When automating tests, one of the challenges is to keep the test resilient to code changes.
Using [data attributes](https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes) can help you with that, by creating unique selectors for your tests.

### Using unique data attributes with ACPaaS UI
### Using unique data attributes with Antwerp UI

It's not possible to add unique attributes to the ACPaaS UI components for the simple reason that the attribute won't be unique anymore when you use the component multiple times on the same page.
It's not possible to add unique attributes to the Antwerp UI components for the simple reason that the attribute won't be unique anymore when you use the component multiple times on the same page.

We solve this problem by adding unique attributes to the individual ACPaaS UI components at app level.
We solve this problem by adding unique attributes to the individual Antwerp UI components at app level.

#### Example

The following example shows the ACPaaS UI Accordion with the unique `qa` data attribute `id-1234`.
The following example shows the Antwerp UI Accordion with the unique `qa` data attribute `id-1234`.

```html
<Accordion qa="id-1234"/>
Expand Down Expand Up @@ -53,7 +53,7 @@ So the compiled code would look like this:

### Overview

To help you locate a specific element of a component, we've made an overview of all ACPaaS UI components and the CSS classes they use. When an element doesn't have a class set, you can still target it by selecting the element type or its custom attribute.
To help you locate a specific element of a component, we've made an overview of all Antwerp UI components and the CSS classes they use. When an element doesn't have a class set, you can still target it by selecting the element type or its custom attribute.

| Component | Class | Element / Attribute | Description |
| -------- | ----- | ------- | ----------- |
Expand Down
2 changes: 1 addition & 1 deletion VERSIONING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ACPaaS UI React - versioning guidelines
# Antwerp UI React - versioning guidelines

This package is supplied as a library.
For now, we will not release separate components on NPM.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@acpaas-ui/react-components",
"version": "5.0.6",
"description": "Antwerp City Platform as a Service User Interface (ACPaas UI) is a component interface library for building user interfaces and responsive web apps.",
"description": "Antwerp UI is a component interface library for building user interfaces and responsive web apps.",
"license": "MIT",
"main": "dist/index.cjs.js",
"module": "dist/index.esm.js",
Expand Down
2 changes: 1 addition & 1 deletion styleguide.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module.exports = {
return webpackConfig;
},
styleguideDir: 'docs',
title: 'ACPaaS UI React Components',
title: 'Antwerp UI React components',
usageMode: 'collapse',
webpackConfig: require('./webpack.config'),
version: `v${pjson.version}`,
Expand Down

0 comments on commit bac7402

Please sign in to comment.