Skip to content

Commit

Permalink
📓 add example of options import usage
Browse files Browse the repository at this point in the history
  • Loading branch information
thinkjrs committed Feb 21, 2024
1 parent 06c3c09 commit b5fb37c
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,13 +243,15 @@ For example,
##### `dashboardOptions`
Users can customize some behavior within the dashboard, such as the support email domain and the local email part.
Users can customize some behavior within the dashboard, such as the support email domain and the local email part. The default options object can be imported directly for ease of use.
> ℹ️ There are two customizable portions in `team@tincre.com`, the **local part**, i.e. `team` and the **email domain**, i.e. `tincre.com`.
For example,
```jsx
import { options } from '@tincre/promo-dashboard'

<PromoDashboard
dashboardOptions={{
emailDomain: 'tincre.com',
Expand All @@ -259,7 +261,7 @@ For example,
promoChatAgentName?: string;
promoChatInputMessagePlaceholder?: string;
promoChatExecuteRecaptcha?: (action: string) => Promise<string>;
campaignTypes?: CampaignType[];
campaignTypes?: options?.campaignTypes;
}}
/>
```
Expand Down

0 comments on commit b5fb37c

Please sign in to comment.