Interface: IRelativityFormsEnvelopeCustomButtonSettings

Settings for a custom button in the action bar

Properties

actionType

actionType: RelativityFormCustomButtonActionType

The button action type, like 'Save'

---

className

className: string

The classes to apply to the button, like 'secondary'

---

id

id: string

The html id of the button

---

isDisabled

isDisabled: boolean

If true, the button is disabled in the action bar

---

name

name: string

The text displayed on the button

---

onBuild()?

optionalonBuild: () => boolean

The onBuild handler to fire when the form loads each time. Return false to not show the button.

Returns

boolean

---

onClick()

onClick: () => void

The onClick handler to fire when a user clicks on the button

Returns

void

---

order

order: number

The order of the buttons from left to right

---

slotPosition

slotPosition: RelativityFormSlotPosition

The slot position of the button in the action bar

---

visibleMode

visibleMode: RelativityFormCustomButtonVisibleMode[]

The modes to display the button in the action bar