promo-dashboard, by Tincre.dev

A dashboard for Tincre Promo. Use it in conjunction with the promo-button.

• promo-dashboard, by Tincre
  • Installation
    • Yarn
    • Npm
    • Environment variables
      • .env.local Example
    • Usage
      • Frontend
        • campaignsData
        • campaignDetailData
        • isLoading
        • handleRepeatButtonClick
        • handleCampaignTypeButtonClick
        • handleSubmitSaveButtonClick
        • profileSettingsData
        • dashboardOptions
      • Backend
      • Styling
  • Support
  • License
  • Development
    • Releases
      • Release prep
        • Test release
      • Release latest tag

Installation

Use your favorite package manager to rock installation of promo-dashboard.

Yarn

yarn add @tincre/promo-dashboard @tincre/promo-chat # -D if you want this as a dev dep

Npm

npm install @tincre/promo-dashboard @tincre/promo-chat # --save-dev if you want it as a dev dep

Environment variables

You'll need the following environment variables available in Node.js:

• PROMO_CLIENT_ID
• PROMO_CLIENT_SECRET
• PROMO_APP_ID
• PROMO_API_KEY (optional)

These values can be found in the Tincre.dev Dashboard after you're logged in and have created at least one app.

.env.local Example

PROMO_API_KEY=
PROMO_CLIENT_ID=
PROMO_APP_ID=
PROMO_CLIENT_SECRET=

Usage

• Import the frontend component
• Add backend functionality
• Update the backend property in your frontend from 1
• Add an environment file, e.g. .env.local
• Add environment variables to your deployment
• Deploy!

Frontend

import { PromoDashboard } from '@tincre/promo-dashboard';
import { PromoChat } from '@tincre/promo-chat';

<PromoDashboard
  campaignsData={campaignsData}
  campaignDetailData={campaignDetailData || undefined}
  isLoading={false}
  handleRepeatButtonClick={handleRepeatButtonClick || undefined}
  PromoChat={PromoChat}
/>;

PromoChat is required to be passed in as a prop so that this library itself doesn't require the explicit dependency.

campaignsData

A simple array of CampaignData types.

campaignDetailData

The CampaignData type.

interface CampaignData {
  pid?: string;
  email?: string;
  adTitle?: string;
  budget?: string | number;
  description?: string;
  target?: string;
  adCopy?: string;
  creativeUrls?: string[];
  adCallToAction?: string;
  buttonText?: string;
  isActive?: boolean;
  currency?: string;
  stats?: object[];
}

isLoading

The Promo Dashboard accepts an optional loading boolean property. Not including the prop or giving isLoading a value of false will render the dashboard in full.

If the isLoading prop is set to true the rendered dashboard frame will be shown.

handleRepeatButtonClick

In order to fully utilize the PromoButton and PromoDashboard together, you should provide a handler similar to the below, defined in your parent component.

import { useState } from 'react';

export default Index() {
  // Add your state hooks
  const [promoCampaignData, setPromoCampaignData] = useState();
  const [isRepeatButtonClicked, setIsRepeatButtonClicked] = useState(false);
  // Add your custom button click callback
  const handleRepeatButtonClick = (
    event,
    data,
  ) => {
    // set at least the following parameters, same type as campaignDetailData
    setPromoCampaignData({
      adTitle: data?.adTitle,
      budget: data?.budget,
      description: data?.description,
      target: data?.target,
      adCopy: data?.adCopy || data?.description,
      adCallToAction: data?.adCallToAction,
      buttonText: data?.buttonText,
    });
    // not required but a useful pattern
    // used to open the promo button when isRepeatButtonClicked === true
    if (typeof setIsRepeatButtonClicked !== 'undefined') {
      setIsRepeatButtonClicked(!isRepeatButtonClicked);
    }
  };
  return <div>
    ...
    <PromoDashboard handleRepeatButtonClick={handleRepeatButtonClick}>
  </div>
};

handleCampaignTypeButtonClick

Applications consuming this library can (and should) customize how the initial user screen campaign type buttons are handled. The default behavior is to do nothing.

This handler accepts the button click event and an eventName string parameter, where the eventName event name provided to the function is the modified value of the name property on the CampaignType type element of the array.

In particular, the name is modified using

name.toLocaleLowerCase().replace(/(\s)/g, '-');

For example, the name "Engagement campaign" will be passed into the function as "engagement-campaign".

These events can be customized using the dashboardOptions.campaignTypes array property.

A complete example:

import { MouseEvent } from 'react';

export function MyApp() {
  const handleCampaignTypeButtonClick = (
    event: MouseEvent<HTMLButtonElement>,
    eventName: string,
  ) => {
    // do whatevs, like open up the Promo Button
    console.log(`${eventName} clicked!`);
  }
  render <PromoDashboard
    handleCampaignTypeButtonClick={handleCampaignTypeButtonClick}
  />
}

handleSubmitSaveButtonClick

Callers can add a handler function to be called on click of the "Save" button rendered in the Profile component.

For example,

import { MouseEvent } from 'react';
import { Settings } from '@tincre/promo-dashboard';

export function MyApp() {
  const handleSettingsSaveButtonOnClick = (event: MouseEvent, data: Settings) => {
    // do whatevs, like track state from above
  }
  render <PromoDashboard
    handleSettingsSaveButtonClick={handleSettingsSaveButtonOnClick}
  />
}

profileSettingsData

You can easily provide the settings data yourself and handle it from outside the dashboard. Simply add a Settings object to your PromoDashboard rendering.

For example,

<PromoDashboard
  handleSettingsSaveButtonClick={handleSettingsSaveButtonOnClick}
  profileSettingsData={{
    userName: 'testUserName',
    fullName: 'Test McTesterson',
    image: 'favicon.ico',
  }}
/>

dashboardOptions

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 [email protected], the local part, i.e. team and the email domain, i.e. tincre.com.

For example,

import { options } from '@tincre/promo-dashboard'

<PromoDashboard
  dashboardOptions={{
    emailDomain: 'tincre.com',
    emailLocalPart: 'awesome-team',
    promoChatApiRoute?: string;
    promoChatStartingAgentMessage?: string;
    promoChatAgentName?: string;
    promoChatInputMessagePlaceholder?: string;
    promoChatExecuteRecaptcha?: (action: string) => Promise<string>;
    campaignTypes?: options?.campaignTypes;
  }}
/>

You can also control whether the table is initially collapsed or not via the optional isTableCollapsed prop. The example below will collapse the table by default.

<PromoDashboard
  dashboardOptions={{
    isTableCollapsed: true,
  }}
/>

The CampaignType object above is shaped as follows

type CampaignType = {
  name: string;
  description?: string;
  icon?:
    | 'eye'
    | 'magnifying-glass'
    | 'rocket-launch'
    | 'calendar'
    | 'newspaper'
    | 'arrow-uturn-left'
    | 'user-group'
    | 'video-camera'
    | 'tag'
    | 'heart'
    | 'megaphone';
  color?: string;
};

Backend

🚧 Features and documentation content updates coming soon!

Styling

The Promo dashboard supports limited styling support. Essentially anything with a prominent color can be customized within your global imported tailwindcss css file.

See the file /styles/global.css in the Next.js example:

#promo-dashboard-save-button {
  @apply bg-red-700 hover:bg-red-900;
}
#promo-dashboard-download-campaign-button {
  @apply bg-red-700 hover:bg-red-900;
}
#promo-dashboard-campaign-detail-back-button {
  @apply bg-red-700 hover:bg-red-900;
}
#promo-dashboard-save-button {
  @apply bg-red-700 hover:bg-red-900;
}
#promo-dashboard-line-chart {
  @apply bg-red-700 hover:bg-red-800;
}
#promo-dashboard-stats-highlights-icon-container {
  @apply bg-red-700;
}
#promo-dashboard-stats-highlights-icon {
  @apply text-slate-900;
}
#promo-dashboard-campaign-delete-button-x-circle-icon {
  @apply hover:bg-blue-700;
}
#promo-dashboard-loading-spinner {
  @apply w-8 h-8 mr-2 text-gray-200 animate-spin dark:text-gray-600 fill-red-700;
}
.promo-dashboard-campaign-delete-button {
  @apply absolute -top-2 x-inset-0;
}
#promo-dashboard-campaigns-table-button-collapse {
  @apply relative overflow-hidden rounded-md bg-slate-50 px-2 py-1 text-xs md:text-sm shadow sm:px-3 sm:py-2 hover:bg-slate-200 hover:shadow-lg border border-1 border-transparent dark:bg-slate-700 dark:text-slate-100 dark:hover:bg-slate-600 mb-2;
}
#promo-dashboard-campaigns-table-container {
  @apply rounded-md;
}
#promo-dashboard-campaigns-table-main {
  @apply h-[380px] overflow-y-auto overflow-x-hidden border border-gray-50 bg-gray-50 shadow-lg rounded-md group-hover:bg-gray-100 dark:group-hover:bg-slate-900 group-hover:shadow-lg dark:bg-slate-800 dark:border-slate-800;
}
#promo-dashboard-campaigns-table-content-container {
  @apply px-4 sm:px-6 lg:px-8 block;
}
#promo-dashboard-campaigns-table-content-margin-container {
  @apply -mx-4 mt-8 sm:-mx-0;
}
#promo-dashboard-campaigns-table {
  @apply min-w-full divide-y divide-gray-300;
}
#promo-dashboard-campaigns-table-column-ads {
  @apply py-3.5 pl-4 pr-3 pb-2 text-left text-sm font-semibold text-gray-900 sm:pl-0 sticky top-0 bg-gray-50 group-hover:bg-gray-100 select-none dark:bg-slate-800 dark:border-slate-700 dark:group-hover:bg-slate-900 dark:text-slate-100;
}
#promo-dashboard-campaigns-table-column-campaign-id {
  @apply hidden px-3 py-3.5 pb-2 text-left text-sm font-semibold text-gray-900 md:table-cell sticky top-0 bg-gray-50 group-hover:bg-gray-100 select-none dark:bg-slate-800 dark:border-slate-700 dark:group-hover:bg-slate-900 dark:text-slate-100;
}
#promo-dashboard-campaigns-table-column-budget {
  @apply hidden px-3 py-3.5 pb-2 text-left text-sm font-semibold text-gray-900 sm:table-cell sticky top-0 bg-gray-50 group-hover:bg-gray-100 select-none dark:bg-slate-800 dark:border-slate-700 dark:group-hover:bg-slate-900 dark:text-slate-100;
}
#promo-dashboard-campaigns-table-column-status {
  @apply px-3 py-3.5 pb-2 text-left text-sm font-semibold text-gray-900 sticky top-0 bg-gray-50 group-hover:bg-gray-100 select-none dark:bg-slate-800 dark:border-slate-700 dark:group-hover:bg-slate-900 dark:text-slate-100;
}
#promo-dashboard-campaigns-table-body {
  @apply divide-y divide-gray-200 bg-gray-50 group-hover:bg-gray-100 dark:bg-slate-800 dark:border-slate-700 dark:group-hover:bg-slate-900 dark:text-slate-100;
}
#promo-dashboard-campaigns-table-row {
  @apply cursor-pointer hover:text-gray-200 dark:bg-slate-800 dark:group-hover:bg-slate-900;
}
#promo-dashboard-campaigns-table-cell-ad-title {
  @apply w-full max-w-0 py-4 pl-4 pr-3 text-sm font-normal text-gray-800 sm:w-auto sm:max-w-none sm:pl-0 text-left dark:bg-slate-800 dark:border-slate-700 dark:group-hover:bg-slate-900 dark:text-slate-100;
}
#promo-dashboard-campaigns-table-cell-pid-small {
  @apply mt-1 truncate text-gray-700 text-left md:hidden dark:text-slate-100;
}
#promo-dashboard-campaigns-table-cell-budget-small {
  @apply mt-1 truncate text-gray-500 sm:hidden dark:text-slate-200;
}
#promo-dashboard-campaigns-table-cell-pid-large {
  @apply hidden px-3 py-4 text-sm text-gray-500 md:table-cell text-left dark:text-slate-200;
}
#promo-dashboard-campaigns-table-cell-budget-large {
  @apply hidden px-3 py-4 text-sm text-gray-500 sm:table-cell text-left dark:text-slate-200;
}
#promo-dashboard-campaigns-table-cell-status {
  @apply px-3 py-4 text-sm text-gray-500 text-left;
}
#promo-dashboard-campaigns-table-bottom-padding {
  @apply pb-12;
}

Support

• Documentation: tincre.dev/docs
• Guides and how-tos: tincre.dev/docs/guides
• Reference docs: tincre.dev/docs/reference
• Community: community.tincre.dev

License

This code is free to use for your commercial or personal projects. It is open-source licensed under the Mozilla Public License 2.0.

You will see various headers throughout the codebase and can reference the license directly via LICENSE herein.

Development

Releases

We use npm for releases. In particular, we use npm --publish to publish.

Currently, only @thinkjrs has the ability to release.

Release prep

Prior to using npm --publish a release tag needs to be created for the library using our standard tagging practices.

Ensure that tests ✅ pass during this process prior to releasing via npm.

Test release

To do a proper release, ensure you're in the base repo directory and run npm publish . --access public --dry-run.

Release latest tag

To complete a full release to the latest npm dist-tag, ensure you're in the base repo directory and run npm publish . --access public.

🎉 That's it! 🎉