Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/indiana-university/lms-canvas-rivet
Bundle of rivet UI things that are useful to lms-canvas LTI tools
https://github.com/indiana-university/lms-canvas-rivet
canvas lms lti rivet
Last synced: about 2 months ago
JSON representation
Bundle of rivet UI things that are useful to lms-canvas LTI tools
- Host: GitHub
- URL: https://github.com/indiana-university/lms-canvas-rivet
- Owner: indiana-university
- License: bsd-3-clause
- Created: 2021-09-23T12:40:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T20:02:03.000Z (4 months ago)
- Last Synced: 2024-09-18T00:37:40.449Z (4 months ago)
- Topics: canvas, lms, lti, rivet
- Language: JavaScript
- Homepage:
- Size: 225 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LMS Canvas Rivet Web Bundle
When this library is added to a project it allows access to a bundle of rivet UI components and add-ons:
| Library | Directory | Files |
|-----------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Datatables Extensions | datatables-ext |
- datatables-ally.css
- datatables-ally.js
- datatables-filters.js
| rivet-clearable-input | rivet-clearable-input |
- rivet-clearable-input.min.js
- rivet-clearable-input.min.css
| rivet-core | rivet-core |
- rivet.css
- rivet.min.css
- rivet.min.js
- rivet-esm.js
- rivet-iife.js
- rivet-umd.js
| rivet-icons | rivet-icons |
- rivet-icon-element.css
- rivet-icon-element.js
- rivet-icons.js
- rivet-icons.json
- ``.js
| rivet-stickers | rivet-stickers |
- rivet-sticker-element.css
- rivet-sticker-element.js
- rivet-stickers.js
- rivet-stickers.json
- ``.js
| scrolltotop | scrolltotop |
- scrolltotop.js
## Installation
### From Maven
Add the following as a dependency in your pom.xml
```xml
edu.iu.uits.lms
lms-canvas-rivet
```
You can find the latest version in [Maven Central](https://search.maven.org/search?q=g:edu.iu.uits.lms%20AND%20a:lms-canvas-rivet).
## Setup Examples
### Add Resource Handler to a Java configuration class
```java
// example class
@Configuration
@EnableWebMvc
public class ApplicationConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/jsrivet/**").addResourceLocations("classpath:/META-INF/resources/jsrivet/").resourceChain(true);
}
}
```
### Ignore jsrivet artifacts in your security setup
```java
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
@Override
public void configure(WebSecurity web) throws Exception {
web.ignoring().antMatchers("/jsrivet/**");
}
}
```
### Link to whatever css and js files you need
```html
```
## Upgrading from rivet-uits (1.x) to rivet-core (2.x)
At the very least, the js/css artifacts are referenced slightly differently:
| Old file | New file |
|----------------------|---------------|
| rivet-bundle.min.css | rivet.min.css |
| rivet-bundle.min.js | rivet.min.js |
Beyond that, consult the specific rivet docs to find out more.
## Upgrading to 5.2.8.0
With the introduction of the new `rivet-stickers` (0.3.0) and changes to `rivet-icons` (3.0.0), we decided to add
directories for organizational purposes. Now, each component will be inside their own directory. The table at the top
of this README should mention those specific details.
## Release Upgrades
For upgrading the rivet version in this service:
package.json: Change the version of the "rivet-core" and check for the latest tag release for "rivet-icons" at https://github.com/indiana-university/rivet-icons
pom.xml: Make sure the SNAPSHOT version matches the rivet-core version to be released
## Scroll to top component
If you want to use the bundled scroll to top component in a tool, you will need the following css, js, and html markup
in the tool to make it function. The html assumes the tool will have Rivet 2 and Rivet Icons.
```
Back to Top
```
## Datatables Extensions
See the [README.md](public/datatables-ext/README.md) in the source for details.