Available as:

Employer pay groups — Employer Pay Groups

Options

Name	Type	Description
`userToken`	String	Required. A User Token with `EMPLOYER_ADMIN` access role for the specified Employer.
`employerId`	String	Required. The id of the Employer.
`displayMode`	String	Configures the layout of the embedded experience. Options are: `drawer`, `modal`, and `inline`. Defaults to `drawer` if not provided.
`title`	String	Optional custom title to display in the layout.
`closeDisabled`	Boolean	Applicable to modal and drawer modes. Disables the close functionality. Consumers are responsible for handling the behavior triggered when the close event occurs. Defaults to `false`.

Refer to the reference on creating elements for the additional options that are available to all elements.

Embedded usage

Element name: employer-pay-groups

Refer to the guide on how to embed an Element with Salsa.js for more detailed instructions.

Example

salsa.elements.create('employer-pay-groups', {
  userToken: 'eyJhbGciO...ajs0Wqw', 
  employerId: 'er_e8343fc7-9d63-4cc5-81ed-c573fc666d37',
  displayMode: 'modal',
  title: 'My custom title',
  closeDisabled: true
});

Events

Refer to the documentation on Element events for more information about events and instructions on how to consume them.

`complete` event

The complete event is triggered when the user adds a pay group and saves.

Event object properties

Name	Type	Description
`elementType`	String	`employer-pay-groups`
`employerId`	String	The id of Employer.
`displayMode`	String	The display mode used (`drawer`, `modal` or `inline`).

`close` event

The close event is triggered when the user completes cancels the paygroup creation flow or closes the drawer/modal.

Event object properties

Name	Type	Description
`elementType`	String	`employer-pay-groups`
`employerId`	String	The id of Employer.
`displayMode`	String	The display mode used (`drawer`, `modal` or `inline`).

Options

Embedded usage

Example

Events

complete event

Event object properties

close event

Event object properties

`complete` event

`close` event