Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alliance-pcsg/primo-explore-custom-actions
:hammer_and_wrench: easily add custom actions to primo-explore's actions menu.
https://github.com/alliance-pcsg/primo-explore-custom-actions
angularjs primo-explore
Last synced: about 1 month ago
JSON representation
:hammer_and_wrench: easily add custom actions to primo-explore's actions menu.
- Host: GitHub
- URL: https://github.com/alliance-pcsg/primo-explore-custom-actions
- Owner: alliance-pcsg
- License: mit
- Created: 2017-01-18T18:29:20.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-09-10T13:03:12.000Z (over 4 years ago)
- Last Synced: 2024-11-19T06:17:00.012Z (about 2 months ago)
- Topics: angularjs, primo-explore
- Language: JavaScript
- Homepage:
- Size: 353 KB
- Stars: 15
- Watchers: 9
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# primo-explore-custom-actions
[](https://www.npmjs.com/package/primo-explore-custom-actions)
## Features
Custom links can be added to the actions menu visible on Primo brief results and full display. Links can extract properties of the item's PNX record and apply them to the link URL.
### Screenshot
## Install
1. Make sure you've installed and configured [primo-explore-devenv](https://github.com/ExLibrisGroup/primo-explore-devenv).
2. Navigate to your template/central package root directory. For example:
```
cd primo-explore/custom/MY_VIEW_ID
```
3. If you do not already have a `package.json` file in this directory, create one:
```
npm init -y
```
4. Install this package:
```
npm install primo-explore-custom-actions --save
```
Alternatively, just copy the contents of `dist/module.js` into your `custom.js` file.
## Usage
Once this package is installed, add `customActions` as a dependency for your custom module definition.
```js
var app = angular.module('viewCustom', ['customActions'])
```
Note: If you're using the `--browserify` build option, you will need to first import the module with:
```javascript
import 'primo-explore-custom-actions';
```
You can add new actions by adding `` elements to the template of `prmActionListAfter`. Each element needs the properties below:
| name | type | usage |
|---|---|---|
| `name` | string | a short, unique name for the action. don't include whitespace characters. |
| `label` | string | the name that will display on the action button. whitespace ok. |
| `index` | integer | where to insert the action. 0 would be "first", 1 would be "second", etc.|
| `icon` | string | the icon on the button. must be chosen from . should be in the form "ic_icon_name_with_underscores_24px". some icons may not display. |
| `icon-set` | string | the set of icons from which the above icon is drawn.|
| `link` | string | URL to open when the action is clicked. supports templating (see below). |
### Templating
You can create interpolation expressions using `{ }` in the link text and they will be replaced with corresponding values taken from the item - for example, `{pnx.control.recordid[0]}` would become the recordID of the item, taken from the pnx.
### Example
The example below will generate a configuration similar to that visible in the screenshot above. It adds a "report problem" link that will navigate to the institution's "report problem" form and append the record ID as a GET parameter, and a link that will open the given record's PNX for viewing.
**Update 2020-08-18:** The previous example node for record IDs, pnx.search.recordid[0], contains long random strings for CDI records instead of the ID used in permalinks. PCSG suggests using pnx.control.recordid[0] instead.
```js
var app = angular.module('viewCustom', ['customActions'])
app.component('prmActionListAfter', {
template: `
`
})
```
[More detailed documentation is available here](https://docs.google.com/document/d/e/2PACX-1vREAWe303KVxb73IVnAQ-Atd1ndZ0bdokiwoe_0fBiGXY7230g6NAjzWPSs0hjmLeSa6xRIoooNfQ4G/pub) on how to link to a specific Primo Record in various reporting systems such as Google Docs, Survey Monkey, and Qualitrics.