Registering for a Samples Bulk Action

This document describes how to add a button action to the sample list page.
Please read up Getting started before starting.

The purpose of a sample bulk action button is that it performs an action on a selection
of 1 or more samples, as opposed to the sample action button in the Sample Details
page that performs an action on only 1 sample.

SDK (original Inventory Browser)

The custom sample bulk action lives within the Sample Actions dropdown. If the button is clicked without
selecting samples first there will be a notice that selecting samples is required. After 1 or more samples
are selected the onSelect logic will apply.

Please find the step by step recipe to add a sample bulk action button.

SDK2 (new Inventory Browser)

📘

Important things to note

• When a button is added with a duplicate ID it will overwrite the existing button. This makes sure that there are no issues with duplicating buttons. This can also be used to update certain properties of the button. For example, if you wanted to change what the label says, you can simply add the button again, with the same ID but with a different label.
• The isVisible property of the button configuration is optional. If no isVisible property is provided it will always show the button.

This button only renders when 1 or more samples are selected in the sample list
because this button is only intended to perform an action on or with a selection
of samples.

Please find the step by step recipe to add a sample bulk action button.