Greeting

The greetings config provides a way for you to present a custom welcome message to the applicant.

Attributes

All attributes are optional unless otherwise indicated.

Attribute	Description
label	string Required. Brief text displayed at the top of the greeting as a heading.
description	string Required. Longer text displayed beneath the label.

To view the full list of available attributes, see the API Reference.

info

You can use the firstName param to show the applicant's first name as specified in the application data.

Example

The following example shows how to configure a greeting with the applicant's first name included in the heading label.

src/configs/custom/process.ts

import { ConfigCurrentSpace } from '@transact-open-ux/workspaces/dist/types';

export const processConfig = ({ firstName }: any): ConfigCurrentSpace => ({
  label: 'Process',
  icon: 'BallotOutlined',
  permissions: {
    type: 'role',
    value: ['Processing Staff', 'Work Spaces Staff'],
  },
    greetings: {
    label: `Welcome back, ${firstName}!`,
    description:
      'Here you will find all the tasks you need to complete in order to finish your application.',
  },
  hideTasks: {
    'Funding Form': ['Funding', 'reviewtemplateform'],
    'Origination Form': ['OriginationForm'],
  },
  ...
});

export default processConfig;