Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nrkno/core-components

Accessible and lightweight Javascript components
https://github.com/nrkno/core-components

a11y accessibility accordion autocomplete calendar datepicker dialog dropdown input javascript lightweight progress-bar react scroll tabs vanilla-js

Last synced: about 2 months ago
JSON representation

Accessible and lightweight Javascript components

Awesome Lists containing this project

README 

        
# @nrk/core-components



## Arkivert



NRK har stoppet aktiv forvaltning og videreutvikling av Core-components. Eventuelle issues og pull-requests vil ikke bli besvart.



Vi anbefaler å undersøke om for eksempel [u-elements](https://u-elements.github.io/u-elements/) kan benyttes som erstatning.



## Archived



NRK is no longer actively maintaining and developing Core-components. New issues or pull-requests will not be considered.



We recommend looking into [u-elements](https://u-elements.github.io/u-elements/) as a possible replacement.



---



[![Playwright Tests](https://github.com/nrkno/core-components/actions/workflows/playwright.yml/badge.svg)](https://github.com/nrkno/core-components/actions/workflows/playwright.yml)



> A kit of lightweight, unstyled and accessible [Javascript](https://stackoverflow.com/questions/20435653/what-is-vanillajs) and [React](https://reactjs.org/) / [Preact](https://github.com/developit/preact-compat) components.

> It provides effortless and flexible usage, while under the hood enhancing markup and functionality for best best user experience across all major browsers and screen readers.



## Documentation



https://static.nrk.no/core-components/latest/



## Local development



First clone `@nrk/core-components` and install its dependencies:



```bash

git clone [email protected]:nrkno/core-components.git

cd core-components

npm install # Installs dependencies for all packages

npm start # Your browser will open documentation with hot reloading

```



## Testing with Playwright



Tests in this project are written using Playwright and are executed against major browser engines including Chromium, WebKit, and Firefox.



### Local Testing



To run tests from the command line, use the following npm command:



```sh

npm run test

```



You can enhance your testing experience in VSCode by using the [Playwright Test for VSCode](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright) plugin.



### Testing in GitHub Actions



The GitHub Actions workflow has been configured to automatically execute Playwright tests in response to changes being pushed to the master branch, as well as when code is pushed upstream to pull requests.



Additionally, it generates test reports and summaries, which are made available as artifacts for the purpose of reviewing and analyzing the test results. Artifacts have a retention period of 30 days.



## Building and committing



After having applied changes, remember to build before pushing the changes upstream.



```bash

git checkout -b feature/my-changes

# update the source code

npm run build

git commit -am ": Add my changes"

git push --set-upstream origin feature/my-changes

# then make PR to the master branch,

# and assign a developer to review your code

```



## Publishing



```bash

npm run publish:minor -- --core-input --core-toggle # Specify packages to publish

```



> NOTE! Please also make sure to keep commits small and clean (that the commit message actually refers to the updated files).

> Stylistically, make sure the commit message is **Capitalized** and **starts with a verb in the present tense** (for example `Add minification support`).