2a1273b683
* Added the new colours to the Tailwind config * Fixed Tsailwind compile errors * WIP Geist working in the app * WIP Storybook * Storybook is working again… ouch * Use Geist mono for CodeMirror * Some find/replace class changes * Resizable colours improved * WIP on primary button * Minor style improvements * Improve the side menu header styling * Improved v2 breadcrumbs * Account side menu tweaks * The page now works with the NavBar and UpgradePrompt * Removed unused import * Refactored the buttons to be dry-er * Removed the breadcrumbs * WIP on nav bar * WIP updating the button styles * Fix for the old test page * Fix for type errors * Removed console.log * Colour change in the resizable handle * New loading bar divider * Removed the design plugin * Creating our own storybook pages * Added some “storybook” pages * Added DetailCell storybook * WIP new animation for the loading page * Added the new loading divider * Fix for the time frame filter having a green border * Style improvements to the new test page * Small style improvements * Improvements to the list pagination components * Nav bar back button improved * Improvements to the run page * Lots of v2 style improvements * Help looks better * Improvements to the regenerate API key modal * More general improvements * Added section titles to our storybook * Added form stories * Fix for missing key prop * Loading bar is working * Fixed button submitting state * Fix for the test button icon * Code bg improved * Improved oauth buttons * Integration page header fix * Various improvements, mainly changing button variants * Segmented control style updates * Added an outline of 3px for the segment control * Fixes for the billing pages * More pricing improvements * Added dialog to storybook * Typography now in storybook * Free usage bar added to storybook * Added inline clode to storybook * Separated menu types into a sub section in storybook * NamedIcon now in storybook * Added page header to storybook * Added pricing callout to storybook * Added radio groups to storybook * Added segmented controllers to storybook * Added shortcuts to storybook * Added switches to storybook * Added toast to storybook * Added tooltips to storybook * Added tree view to storybook * Added usage charts to storybook * Tarted up the environment variables page * Fix for the FreePlanUsage panel bg colours * Added new badge variants * Added the <TaskPath /> to the tasks table * Span header improvements * Started work on the timeline * Started work on the timeline * Fix for the run page header * Timeline tick marks are working * Timeline working * Got the durations showing on hover * Button improvements * Experimenting with how the duration should be shown * Lots of refinements to the timeline * Much nicer API for the Timeline * The switch is now purple to match the design, with inverted thumb when on * Removed old stuff * Export the props * Added the span with duration back in * Simplified more and fixed the span durations * Put in some decent dummy data * Rendering defaults * Wip with the mouse cursor * Improvements to the story * Added Slider primitive * Integrated the icons into the slider * Lots of layout improvements * Cleaned up imports * “Root” indicator * Animated background on partials * Pull the styles through to the spans and log dots * Fixed some bugs in the TreeView when nodes get created or destroyed * Fix for incorrect parentTask reference * Added run streaming endpoint for live refreshing * Added the tabs to Storybook * Fix for status font size mismatch * Fix for the misaligned run filter status * Set a minimum duration on the timeline * The TreeView now re-calculates if the number of nodes has changed * Partials now render to the end * Improved the durations gutter * The duration is calculated using the current time if there are partial events * Added the environment label to storybook * Improved the environment label style * Removed bottom margin from badge * Button style improvements * Callouts style fits the new design better * Got the scrollbars to appear on the tree/timeline * Added scroll support * Synced scrolling working * Close button and exit icon for the detail panel * secure field shows start of env * Clipboard improvements * Latest lockfile * Fix for the durations wrapping --------- Co-authored-by: James Ritchie <james@jamesritchie.co.uk>
87 lines
3.6 KiB
TypeScript
87 lines
3.6 KiB
TypeScript
import { useState } from "react";
|
|
import { CodeExample } from "~/routes/resources.codeexample";
|
|
import { Api } from "~/services/externalApis/apis.server";
|
|
import { cn } from "~/utils/cn";
|
|
import { Feedback } from "../Feedback";
|
|
import { Header1, Header2, Header3 } from "../primitives/Headers";
|
|
import { Paragraph } from "../primitives/Paragraph";
|
|
import { TextLink } from "../primitives/TextLink";
|
|
|
|
export function CustomHelp({ api }: { api: Api }) {
|
|
const [selectedExample, setSelectedExample] = useState(0);
|
|
|
|
const changeCodeExample = (index: number) => {
|
|
setSelectedExample(index);
|
|
};
|
|
|
|
return (
|
|
<div className="mt-4">
|
|
<Header1 className="mb-2">Using {api.name} with an SDK or requests</Header1>
|
|
<Paragraph spacing>
|
|
You can use Trigger.dev with any existing Node SDK or even just using fetch. You can
|
|
subscribe to any API with{" "}
|
|
<TextLink href="https://trigger.dev/docs/documentation/concepts/http-endpoints">
|
|
HTTP endpoints
|
|
</TextLink>{" "}
|
|
and perform actions by wrapping tasks using{" "}
|
|
<TextLink
|
|
href="https://trigger.dev/docs/documentation/guides/writing-jobs-step-by-step#create-your-own-tasks"
|
|
className="font-mono"
|
|
>
|
|
io.runTask
|
|
</TextLink>
|
|
. This makes your background job resumable and appear in our dashboard.
|
|
</Paragraph>
|
|
|
|
{api.examples && api.examples.length > 0 ? (
|
|
<>
|
|
<Header2 className="mb-2">Example {api.name} code</Header2>
|
|
<Paragraph spacing className="mb-4">
|
|
This is how you can use {api.name} with Trigger.dev. This code can be copied and
|
|
modified to suit your use-case.
|
|
</Paragraph>
|
|
{api.examples.length > 1 && (
|
|
<div className=" flex w-full flex-row gap-4 overflow-x-scroll scrollbar-thin scrollbar-track-transparent scrollbar-thumb-charcoal-600">
|
|
{api.examples?.map((example, index) => (
|
|
<button
|
|
onClick={() => changeCodeExample(index)}
|
|
key={example.codeUrl}
|
|
className={cn(
|
|
"w-64 min-w-[16rem] p-2 transition-colors duration-300 sm:w-full sm:rounded",
|
|
"border-px focus:border-px cursor-pointer border border-charcoal-900 bg-charcoal-900 text-charcoal-300 transition duration-300 hover:bg-charcoal-800 focus:border focus:border-indigo-600"
|
|
)}
|
|
>
|
|
{example.title}
|
|
</button>
|
|
))}
|
|
</div>
|
|
)}
|
|
<CodeExample example={api.examples[selectedExample]} />
|
|
</>
|
|
) : (
|
|
<>
|
|
<Header2 className="mb-2">Getting started with {api.name}</Header2>
|
|
<Paragraph spacing className="mb-4">
|
|
We recommend searching for the official {api.name} Node SDK. If they have one, you can
|
|
install it and then use their API documentation to get started and create tasks. If they
|
|
don't, there are often third party SDKs you can use instead.
|
|
</Paragraph>
|
|
<Paragraph spacing className="mb-4">
|
|
Please{" "}
|
|
<Feedback
|
|
button={
|
|
<span className="cursor-pointer text-indigo-500 transition duration-300 hover:text-indigo-400">
|
|
reach out to us
|
|
</span>
|
|
}
|
|
defaultValue="help"
|
|
/>{" "}
|
|
if you're having any issues connecting to {api.name}, we'll help you get set up as
|
|
quickly as possible.
|
|
</Paragraph>
|
|
</>
|
|
)}
|
|
</div>
|
|
);
|
|
}
|