https://github.com/oaf-project/oaf-side-effects

A collection of DOM side-effecting functions to improve the accessibility and usability of single page apps.
https://github.com/oaf-project/oaf-side-effects

accessibility single-page-applications typescript

Last synced: 6 months ago
JSON representation

A collection of DOM side-effecting functions to improve the accessibility and usability of single page apps.

• Host: GitHub
• URL: https://github.com/oaf-project/oaf-side-effects
• Owner: oaf-project
• License: mit
• Created: 2019-04-04T05:17:02.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-08T11:51:22.000Z (10 months ago)
• Last Synced: 2024-11-11T19:28:04.990Z (7 months ago)
• Topics: accessibility, single-page-applications, typescript
• Language: TypeScript
• Homepage: https://oaf-project.github.io/oaf-side-effects/
• Size: 1.49 MB
• Stars: 12
• Watchers: 1
• Forks: 1
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://github.com/oaf-project/oaf-side-effects/actions/workflows/main.yml/badge.svg)](https://github.com/oaf-project/oaf-side-effects/actions/workflows/main.yml)

[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Foaf-project%2Foaf-side-effects%2Fmaster%2Fpackage.json)](https://github.com/plantain-00/type-coverage)

[![Codecov](https://img.shields.io/codecov/c/github/oaf-project/oaf-side-effects.svg)](https://codecov.io/gh/oaf-project/oaf-side-effects)

[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Foaf-project%2Foaf-side-effects%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/oaf-project/oaf-side-effects/master)

[![Known Vulnerabilities](https://snyk.io/test/github/oaf-project/oaf-side-effects/badge.svg?targetFile=package.json)](https://snyk.io/test/github/oaf-project/oaf-side-effects?targetFile=package.json)

[![npm](https://img.shields.io/npm/v/oaf-side-effects.svg)](https://www.npmjs.com/package/oaf-side-effects)

[![npm](https://img.shields.io/npm/dw/oaf-side-effects.svg)](https://www.npmjs.com/package/oaf-side-effects)

# Oaf Side Effects

A collection of DOM side-effecting functions to improve the accessibility and usability of single page apps.

## Installation

```sh

# yarn

yarn add oaf-side-effects

# npm

npm install oaf-side-effects

```

## Browser support

* Oaf Side Effects supports the smooth scrolling option of [scrollIntoView()](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView), so you might want to use the [smoothscroll polyfill](http://iamdustan.com/smoothscroll/).

## See also

* [Oaf Routing](https://github.com/oaf-project/oaf-routing)