Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pmcfernandes/Bootstrap.A11y
Twitter Bootstrap Controls for ASP.NET
https://github.com/pmcfernandes/Bootstrap.A11y
bootstrap c-sharp css html5 javascript
Last synced: 7 days ago
JSON representation
Twitter Bootstrap Controls for ASP.NET
- Host: GitHub
- URL: https://github.com/pmcfernandes/Bootstrap.A11y
- Owner: pmcfernandes
- License: gpl-3.0
- Created: 2013-03-01T14:32:28.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-12-04T23:55:28.000Z (almost 2 years ago)
- Last Synced: 2024-08-30T19:35:44.319Z (2 months ago)
- Topics: bootstrap, c-sharp, css, html5, javascript
- Language: C#
- Homepage:
- Size: 11 MB
- Stars: 33
- Watchers: 7
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bootstrap.A11y
A collection of accessible [Twitter Bootstrap v3.4.1(https://github.com/twbs/bootstrap/tree/v3.4.1) user controls for ASP.NET. It's easy to forget to add ARIA attributes and other accessibility markup. With these controls, it's all handled for you!
This project add features additional controls and accessibility markup. Care has been taken to maintain backwards compatibility, making the transition from Tie.Controls.Bootstrap to Bootstrap.A11y as smooth as possible.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Installing the Package
Just open your Visual Studio and in Tools > Nuget > Package Manager Console write follow line
Install-Package Bootstrap.A11y
See more informations here: https://www.nuget.org/packages/Bootstrap.A11y/
### Registering the Controls
Add the following entry to your root [web.config](Samples/Web.config) file. This registers the controls for use anywhere on your site with the `twt:` prefix:
If you only want the Bootstrap controls to be available in part of your website, you can add the above entry to a non-root web.config file.
If you want a different tag prefix than `twt:`, edit the entry accordingly.
### Configuration
By default, the CSS and JavaScript of the [PayPal Bootstrap Accessibility Plugin](https://github.com/paypal/bootstrap-accessibility-plugin) are added to the page (using embedded resources and ClientScriptManager) when any of the following controls are added to a page:
* Alert
* Dropdown
* Carousel
* Modal
* TabControl
This behavior can be modified in the `appSettings` section of your root [web.config](Samples/Web.config) file:
If you are already including the Bootstrap Accessibility Plugin CSS and/or JS in your site, you can disable the ClientScriptManager injection by adding one or both of the following settings:
Alternatively, if you don't want either injected, you can use this setting instead:
If you prefer to use [jongund's modified version of the PayPal Bootstrap Accessibility Plugin](https://github.com/jongund/bootstrap-accessibility-plugin/), you can add this setting:
**Note:** The value of `Bootstrap.AccessibilityPlugin` should be the same across the site. Changing the value in a child web.config file will lead to unexpected results as the value is loaded from configuration once and stored in a static property.
## Deployment
When deploying to a server, only the `Bootstrap.A11y.dll` file is needed.
## Documentation
[HTML documentation](https://github.com/pmcfernandes/Bootstrap.A11y/docs/) is available within the project's [`docs` folder](docs/). This documentation is generated using [Sandcastle Help File Generator](https://ewsoftware.github.io/SHFB/index.html).
### Some Examples of Usage
The [Samples project](Samples/) provides additional examples based on the [Bootstrap v3.3 documentation](https://getbootstrap.com/docs/3.3/). Simply open and run the project on your local machine.
#### [Page Header](Samples/css/type.aspx)
#### [Labels](Samples/components/labels.aspx)
#### [Badges](Samples/components/badges.aspx)
#### [Button Groups](Samples/components/btn-groups.aspx)
#### [Toolbars](Samples/components/btn-groups.aspx)
#### [ProgressBars](Samples/components/progress.aspx)
#### [Alerts](Samples/components/alerts.aspx)
Well done! You successfully read this important alert message.
## Authors
* **Pedro Fernandes** - *Initial work* - [pmcfernandes](https://github.com/pmcfernandes)
* **Kinsey Roberts** - *Accessibility overhaul* - [kinzdesign](https://github.com/kinzdesign) for [Weatherhead School of Management](https://github.com/wsomweb) at [Case Western Reserve University](https://github.com/cwru)
## License
The code in this project is licensed under the GNU General Public License - see the [LICENSE](LICENSE) file for details.
The documentation in the Samples project is adapted from the [Bootstrap team](https://github.com/twbs)'s [version 3.3.7 documentation](https://getbootstrap.com/docs/3.3/) under the [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) license and is released under the same [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) license.