Home screen

Shake enables you to customize home screen according to your preferences and needs.

Home screen actions

By default, Home screen shows Submit new ticket button and New chat button at the top of the screen. If you want, you can extend or customize these buttons using the custom actions.

There are several types of actions you can set on the home screen.

Custom action

Tap on the custom action executes a custom function.

ShakeHomeAction

Properties:

• title string - represents button title
• subtitle string | null - represents button subtitle
• icon string | null - represents button icon in base64 format
• handler ()=>void | null - function executed on button tap

Submit new ticket action

Tap on the submit new ticket action start a new ticket screen.

ShakeSubmitAction

Properties:

• title string - represents button title
• subtitle string | null - represents button subtitle
• icon string | null - represents button icon in base64 format

Use new ShakeSubmitAction() if you want default values for this action.

Start new chat action

Tap on the new chat action starts a new chat screen.

ShakeChatAction

Properties:

• title string - represents button title
• subtitle string | null - represents button subtitle
• icon string | null - represents button icon in base64 format

Use new ShakeChatAction() if you want default values for this action.

note

Start a new chat action won't be visible if your app user is not registered.

Setting up custom actions

Here's an example how you can set custom actions on the home screen:

App.js

const setShakeHomeActions = () => {
    const actions = [
        new ShakeHomeAction(
            'Visit our roadmap',
            'Check what features are next',
            roadmapImage,
            () => {
                // Open URL
            },
        ),
        new ShakeSubmitAction(
            'Submit a new ticket',
            'Let us know your problem',
            submitImage,
        ),
        new ShakeChatAction(
            'Start a chat',
            'We are here to answer you questions',
            chatImage,
        ),
    ];

    Shake.setHomeActions(actions);
};

note

Custom action icon should be in the base64 format without prefix eg. data:image/png;base64,...

Home screen subtitle

If you want to change subtitle message on the home screen, you can do it using the following method:

App.js

Shake.setHomeSubtitle("Feel free to submit your bug reports, suggestions and questions to us.");