Skip to content

folio-org/ui-plugin-find-agreement

Repository files navigation

ui-plugin-find-agreement

Copyright (C) 2017-2019 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Introduction

This package furnishes a single Stripes plugin of type find-agreement, which can be included in Stripes modules by means of a <Pluggable type="find-agreement"> element. See the Plugins section of the Module Developer's Guide.

Props

Name Type Description Required
onAgreementSelected func: (agreement) => {} Callback fired when a user clicks a agreement Yes
dataKey string Optional dataKey passed to stripes/connect when creating the connected Agreements component.
renderTrigger func: ({ triggerId, onClick, buttonRef }) => {} Optional render function for the button to open the License search modal. The onClick prop should be called when the trigger is clicked (assuming it is a Button). The buttonRef ensures that the trigger button is brought back into focus once the lookup modal is closed

Additional information

Other modules.

See project ERM at the FOLIO issue tracker.

Other FOLIO Developer documentation is at dev.folio.org