Giter VIP home page Giter VIP logo

primo-explore-report-problem's Introduction

primo-explore-report-problem

npm

Features

A banner with a link to report a problem/bug appears below the "send to" actions in the details view. The text of the banner is configurable, and clicking the button will redirect to an external URL and pass the parameters of the current search to that URL. This can be used to auto-fill an external "report problem" form.

Screenshot

screenshot

Install

  1. Make sure you've installed and configured 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-report-problem
    

alternatively, just copy dist/module.js into your package's custom.js file.

Usage

Once this package is installed, add reportProblem as a dependency for your custom module definition.

var app = angular.module('viewCustom', ['reportProblem'])

Then, enable the customization by embedding it in the prmActionListAfter hook:

app.component('prmActionListAfter', {template: '<oca-report-problem />'})

Configuration

You can configure the banner by passing in attributes to the oca-report-problem element. The report-url property is required; the others will default to the values shown in the screenshot.

name type usage
message-text string banner text displayed next to the button.
button-text string text displayed on the button itself.
report-url string (url) base URL for your 'report a problem' page, to which all of the search parameters will be sent

The line below would add a banner with different button and message texts.

app.component('prmActionListAfter', {template: '<oca-report-problem report-url="http://my.library.edu/reportproblem.php?" message-text="Want to report a problem?" button-text="Submit report" />'})

When the button is clicked, if the user was viewing a page like: https://primo.lclark.edu/primo-explore/fulldisplay?docid=CP71139633100001451&context=L&vid=......

They would be sent to: http://my.library.edu/reportproblem.php?docid=CP71139633100001451&context=L&vid=.....

All of the URL parameters could then be handled by a server-side script.

Running tests

  1. Clone the repo
  2. Run npm install
  3. Run npm test

primo-explore-report-problem's People

Contributors

blakeegee avatar jeremymcwilliams avatar thatbudakguy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

primo-explore-report-problem's Issues

Add tests

  • Add testing dependencies
  • Add unit tests
  • Setup travis

Refactor as component

Need to make this thing its own component so it can be used in e.g. the central package.

Pass absolute URL instead of URL params?

@blakeegee noted that since the module now supports the /openurl endpoint, there's a wide range of possible params to pass. It might be more beneficial to pass the entire URL as-is.

$location.absUrl() might be useful here. we might also need to send it thru POST instead of GET, since the URL could be long and encoding could be tough.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.