Skip to content

feat: add headless and unstyled component configs #802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
juliusmarminge wants to merge 1 commit into from
Closed

feat: add headless and unstyled component configs #802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 22 additions & 9 deletions packages/react/src/components/button.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,13 @@ export function UploadButton<
> &
UploadThingInternalProps;

const { mode = "auto", appendOnPaste = false } = $props.config ?? {};
const {
mode = "auto",
appendOnPaste = false,
headless = false,
unstyled = false,
} = $props.config ?? {};
const applyDefaultStyling = !headless && !unstyled;

const useUploadThing = INTERNAL_uploadthingHookGen<TRouter>({
url: resolveMaybeUrlArg($props.url),
Expand Down Expand Up @@ -202,6 +208,7 @@ export function UploadButton<
styleFieldArg,
);
if (customContent) return customContent;
if (headless) return null;

if (state === "readying") {
return "Loading...";
Expand Down Expand Up @@ -231,7 +238,8 @@ export function UploadButton<
}
}}
className={twMerge(
"h-[1.25rem] cursor-pointer rounded border-none bg-transparent text-gray-500 transition-colors hover:bg-slate-200 hover:text-gray-600",
applyDefaultStyling &&
"h-[1.25rem] cursor-pointer rounded border-none bg-transparent text-gray-500 transition-colors hover:bg-slate-200 hover:text-gray-600",
styleFieldToClassName($props.appearance?.clearBtn, styleFieldArg),
)}
style={styleFieldToCssObject($props.appearance?.clearBtn, styleFieldArg)}
Expand All @@ -246,7 +254,7 @@ export function UploadButton<
const renderAllowedContent = () => (
<div
className={twMerge(
"h-[1.25rem] text-xs leading-5 text-gray-600",
applyDefaultStyling && "h-[1.25rem] text-xs leading-5 text-gray-600",
styleFieldToClassName($props.appearance?.allowedContent, styleFieldArg),
)}
style={styleFieldToCssObject(
Expand All @@ -264,7 +272,8 @@ export function UploadButton<
return (
<div
className={twMerge(
"flex flex-col items-center justify-center gap-1",
applyDefaultStyling &&
"flex flex-col items-center justify-center gap-1",
$props.className,
styleFieldToClassName($props.appearance?.container, styleFieldArg),
)}
Expand All @@ -273,11 +282,15 @@ export function UploadButton<
>
<label
className={twMerge(
"relative flex h-10 w-36 cursor-pointer items-center justify-center overflow-hidden rounded-md text-white after:transition-[width] after:duration-500 focus-within:ring-2 focus-within:ring-blue-600 focus-within:ring-offset-2",
state === "readying" && "cursor-not-allowed bg-blue-400",
state === "uploading" &&
`bg-blue-400 after:absolute after:left-0 after:h-full after:bg-blue-600 after:content-[''] ${progressWidths[uploadProgress]}`,
state === "ready" && "bg-blue-600",
...(applyDefaultStyling
? [
"relative flex h-10 w-36 cursor-pointer items-center justify-center overflow-hidden rounded-md text-white after:transition-[width] after:duration-500 focus-within:ring-2 focus-within:ring-blue-600 focus-within:ring-offset-2",
state === "readying" && "cursor-not-allowed bg-blue-400",
state === "uploading" &&
`bg-blue-400 after:absolute after:left-0 after:h-full after:bg-blue-600 after:content-[''] ${progressWidths[uploadProgress]}`,
state === "ready" && "bg-blue-600",
]
: []),
styleFieldToClassName($props.appearance?.button, styleFieldArg),
)}
style={styleFieldToCssObject($props.appearance?.button, styleFieldArg)}
Expand Down
12 changes: 12 additions & 0 deletions packages/react/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,18 @@ export type UploadthingComponentProps<
config?: {
mode?: "auto" | "manual";
appendOnPaste?: boolean;
/**
* Enabling this will disable all default rendering.
* You'll have to render the different parts of the component yourself using the `content` prop
* @default false
*/
headless?: boolean;
/**
* Enabling this will disable the default styling of the component.
* Unlike `headless`, elements will still be rendered, but they will have no styling applied to them.
* @default false
*/
unstyled?: boolean;
};
} & ExtendObjectIf<
inferEndpointInput<TRouter[TEndpoint]>,
Expand Down