@bibleup/bibleup
v1.1.0
Published
A tool for converting Bible references on a webpage to links with an accessible popover
Downloads
19
Maintainers
Readme
What is BibleUp?
BibleUp makes Bible references on a webpage easily accessible without the need of leaving the page. This tool converts Bible references found on a webpage into clickable links, and upon hovering over these links, a feature-rich and flexible popover appears, providing the relevant Bible text.
Features
- Easy integration - simply install and configure.
- Powerful and smart tagging - supports abbreviated books, verse ranges, multiple references and version tagging.
- Highly customizable popover - style according to your site theme.
- Robust Configuration
- Supports different Bible versions - up to 10 versions
- Fast and performant - no site bloats
- Extensive browsers support
- Follows WAI-ARAI accessibility guidelines - for screen readers and keyboard navigation.
- BibleUp Editor - style popover in real-time and export options
Example
This is a minimal example of BibleUp options and usage (check the docs for full options):
const page = new BibleUp(document.body, {
version: 'KJV',
popup: 'classic',
darkTheme: true,
styles: {
fontSize: '15px',
borderRadius: '20px 15px',
}
});
// activate BibleUp 💡
page.create();
Documentation
Using BibleUp is as simple as it can get. See the docs for installation, usage and how to configure Bibleup.
Plugin and Extension
Browsers support
| IE / Edge | Firefox | Chrome | Safari | iOS Safari | Opera | Opera Mini | | --------- | --------- | --------- | --------- | --------- | --------- | --------- | | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅
Contributing
Feature requests and issues are always welcomed. Kindly make sure you state the specifics in detail, whether a bug, feature request or a fix. You can also contibute to this project as a blogger, reviewer, or even as an organisation. See how to contribute Thank you for choosing to contribute!
Credits
Special thanks to API.Bible and Bolls.life 🙏
[!IMPORTANT] BibleUp does not store or process Bible versions or translations but rather relies on external API providers. For more information on quote permissions and compliance, please read our copyright notice
Licence
BibleUp core is available under the MIT Licence.Other derivative projects may carry a different licence.