primo-explore-custom-search-bookmark-filter

Description

Override the default options in the search bookmark filter menu for the primo-explore UI.

Screenshot

Installation

1. Assuming you've installed and are using 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-search-bookmark-filter --save-dev
   

Usage

Once installed, inject customSearchBookmarkFilter as a dependency:

let app = angular.module('viewCustom', ['customSearchBookmarkFilter'])

Note: If you're using the --browserify build option, you will need to first import the module with:

import 'primo-explore-custom-search-bookmark-filter';

You'll need to configure the module by passing it an array of objects as an angular constant:

name	type	usage
cssClasses	string	extra css classes to put on the buttons
name	string	the text that will appear as the button link
description	string	for the aria label
action	string	url for the link. always opens in a new window.
icon	object	defines the icon for the link. must be chosen from https://material.io/icons/. you need to specify both the name of the action "set" (see link) and the icon itself, in the form "ic_person_outline_24px". note that all icons do not work so you may have to experiment some

Translations

You can use translations to access back office text by wrapping the value in curly braces, e.g. {nui.menu.librarycard}. Anything that works in the primo templates link this <span translate="nyu.menu.librarycard"></span> will work if it's available in the current scope.

Example

app.constant('customSearchBookmarkFilterItems',
  [
    {
      cssClasses: 'button-over-dark',
      name: "My e-Shelf",
      description: "Go to {nui.menu.librarycard}",
      action: "https://eshelf.library.edu",
      icon: {
        set: 'image',
        icon: 'ic_collections_bookmark_24px'
      }
    }
  ]
)