Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump version (and add section to README) #24

Merged
merged 2 commits into from
Dec 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,20 @@ Blacklight::Hierarchy::Engine.config.opened_icon = '➖'

```

### Aria Labels
For screen reader purposes we have used "Toggle subgroup" as the aria-label attribute of the button. This is internationalized using rails' i18n feature.

The field name is used in the key to allow for facet specific aria labels or defaults back to the generic key/"Toggle subgroup" text.

```yml
# config/locales/en.yml
en:
blacklight:
hierarchy:
format_ssim_toggle_aria_label: Toggle format section
toggle_aria_label: Toggle call number section
```

## Caveats

This code was ripped out of another project, and is still quite immature as a standalone project. Every effort has been made to make it as plug-and-play as possible, but it may stomp on Blacklight in unintended ways (e.g., ways that made sense in context of its former host app, but which aren't compatible with generic Blacklight). Proceed with caution, and report issues.
Expand Down
2 changes: 1 addition & 1 deletion lib/blacklight/hierarchy/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module Blacklight
module Hierarchy
VERSION = '3.0.0'.freeze
VERSION = '4.0.0'.freeze
end
end