NativeScript Accessibility repo
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
.npmignore
README.md
accessibility.js
package.json

README.md

npm npm npm

nativescript-accessibility

Add full accessibility to the NativeScript framework

WARNING: The code is NOT "officially" on NPM yet, the code/plugin is available to Patreon supporters or purchasable via http://nativescript.tools

THIS is on NPM to be used as a Placeholder so that this plugin does have a home when(if?) it is ever released open source.

License

The actual code is released under what I call the PATRON License, meaning you are free to include this in any type of program as long as you downloaded this when you were a current multi-month patron/sponsor, and got the file directly from the patreon post.

Depending on the support of the plugin from Patron's -- it may be released under a proper open source license at a time of my choosing (typically after a couple months of exclusive access by sponsor's). At that point the product will be re-released under the MIT license.

In addition to the PATRON license, you can purchase this directly under a COMMERCIAL license from the http://nativescript.tools site.

I also do contract work; so if you have a module you want built for NativeScript (or any other softw

Donate Patreon

Installation

Download from the patreon link

tns plugin add nativescript-accessibility-1.0.0.tgz

Usage

To use the module you just require() it:

require( "nativescript-accessibility" );

Notice: You do NOT need to keep a reference to it; and you only need to load it once.
It will automatically attach its methods to all the proper classes in the NativeScript library making it act as if they are built in.

XML/Declarative ui access

Properties

accessibilityText (String = defaults to not set)

This is the text for a screen reader to read (or other accessibility device)

  someViewElement.accessibilityText = "A Screen reader will read this text.";

accessibilityHidden (Boolean = defaults to false)

This allows you to hide this object from a accessibility device

  someViewElement.accessibilityHidden = true;