Skip to content

Visualize Your Ideas With Code

refactor: replace the classes util with clsx (#122)

Jacob9a7899d8a64a
diff --git a/package-lock.json b/package-lock.json
index e3198f50..0d80b48d 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -7911,7 +7911,8 @@
},
"node_modules/clsx": {
"version": "1.2.1",
- "license": "MIT",
+ "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz",
+ "integrity": "sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg==",
"engines": {
"node": ">=6"
}
@@ -20751,6 +20752,7 @@
"devDependencies": {
"@motion-canvas/core": "^12.0.0",
"@preact/preset-vite": "^2.3.0",
+ "clsx": "^1.2.1",
"preact": "10.7.3",
"source-map-js": "^1.0.2",
"typescript": "^4.6.4",
@@ -23995,6 +23997,7 @@
"requires": {
"@motion-canvas/core": "^12.0.0",
"@preact/preset-vite": "^2.3.0",
+ "clsx": "*",
"preact": "10.7.3",
"source-map-js": "^1.0.2",
"typescript": "^4.6.4",
@@ -26139,7 +26142,9 @@
}
},
"clsx": {
- "version": "1.2.1"
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz",
+ "integrity": "sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg=="
},
"cmd-shim": {
"version": "5.0.0",
diff --git a/packages/ui/package.json b/packages/ui/package.json
index 034d1895..1fa9417a 100644
--- a/packages/ui/package.json
+++ b/packages/ui/package.json
@@ -29,6 +29,7 @@
"devDependencies": {
"@motion-canvas/core": "^12.0.0",
"@preact/preset-vite": "^2.3.0",
+ "clsx": "^1.2.1",
"preact": "10.7.3",
"source-map-js": "^1.0.2",
"typescript": "^4.6.4",
diff --git a/packages/ui/src/components/console/Console.tsx b/packages/ui/src/components/console/Console.tsx
index db05a0ca..855bd56f 100644
--- a/packages/ui/src/components/console/Console.tsx
+++ b/packages/ui/src/components/console/Console.tsx
@@ -4,10 +4,10 @@ import {LogLevel} from '@motion-canvas/core/lib';
import {capitalize} from '@motion-canvas/core/lib/utils';
import {Pane} from '../tabs';
import {useLogs} from '../../contexts';
-import {classes} from '../../utils';
import {useState} from 'preact/hooks';
import {IconButton, IconType, Pill} from '../controls';
import {Log} from './Log';
+import clsx from 'clsx';
const LOG_LEVELS: Record<string, boolean> = {
[LogLevel.Error]: true,
@@ -50,7 +50,7 @@ export function Console() {
)}
</div>
<div
- className={classes(
+ className={clsx(
styles.list,
...Object.entries(filters)
.filter(([, enabled]) => enabled)
diff --git a/packages/ui/src/components/console/Log.tsx b/packages/ui/src/components/console/Log.tsx
index bf8f7a1b..4d66dc83 100644
--- a/packages/ui/src/components/console/Log.tsx
+++ b/packages/ui/src/components/console/Log.tsx
@@ -2,12 +2,13 @@ import styles from './Console.module.scss';
import {LogLevel, LogPayload} from '@motion-canvas/core';
import {useEffect, useMemo, useState} from 'preact/hooks';
-import {classes, resolveStackTrace, StackTraceEntry} from '../../utils';
+import {resolveStackTrace, StackTraceEntry} from '../../utils';
import {useInspection} from '../../contexts';
import {useFormattedNumber} from '../../hooks';
import {IconButton, IconType, Toggle} from '../controls';
import {StackTrace} from './StackTrace';
import {SourceCodeFrame} from './SourceCodeFrame';
+import clsx from 'clsx';
export interface LogProps {
payload: LogPayload;
@@ -37,10 +38,11 @@ export function Log({payload}: LogProps) {
return (
<div
- className={classes(styles.log, styles[payload.level], [
- styles.empty,
- !hasBody,
- ])}
+ className={clsx(
+ styles.log,
+ styles[payload.level],
+ !hasBody && styles.empty,
+ )}
>
<div className={styles.header}>
{hasBody && <Toggle open={open} onToggle={setOpen} />}
diff --git a/packages/ui/src/components/console/StackTrace.tsx b/packages/ui/src/components/console/StackTrace.tsx
index b608ea12..11eb0064 100644
--- a/packages/ui/src/components/console/StackTrace.tsx
+++ b/packages/ui/src/components/console/StackTrace.tsx
@@ -1,6 +1,7 @@
import styles from './Console.module.scss';
-import {classes, openFileInEditor, StackTraceEntry} from '../../utils';
+import {openFileInEditor, StackTraceEntry} from '../../utils';
+import clsx from 'clsx';
export interface StackTraceProps {
entries: StackTraceEntry[];
@@ -11,7 +12,7 @@ export function StackTrace({entries}: StackTraceProps) {
<div className={styles.stack}>
{entries.map(entry => (
<div
- className={classes(styles.entry, [styles.external, entry.isExternal])}
+ className={clsx(styles.entry, entry.isExternal && styles.external)}
>
at (
{entry.isExternal ? (
diff --git a/packages/ui/src/components/controls/Button.tsx b/packages/ui/src/components/controls/Button.tsx
index 06aadd63..cc9827e7 100644
--- a/packages/ui/src/components/controls/Button.tsx
+++ b/packages/ui/src/components/controls/Button.tsx
@@ -1,6 +1,6 @@
import styles from './Controls.module.scss';
import type {JSX} from 'preact';
-import {classes} from '../../utils';
+import clsx from 'clsx';
interface ButtonProps extends JSX.HTMLAttributes<HTMLButtonElement> {
main?: boolean;
@@ -9,7 +9,7 @@ interface ButtonProps extends JSX.HTMLAttributes<HTMLButtonElement> {
export function Button(props: ButtonProps) {
return (
<button
- className={classes(styles.button, [styles.main, props.main])}
+ className={clsx(styles.button, props.main && styles.main)}
type={'button'}
{...props}
/>
diff --git a/packages/ui/src/components/controls/Icon.tsx b/packages/ui/src/components/controls/Icon.tsx
index 992952d8..d80c59ba 100644
--- a/packages/ui/src/components/controls/Icon.tsx
+++ b/packages/ui/src/components/controls/Icon.tsx
@@ -1,8 +1,8 @@
import styles from './Controls.module.scss';
import {IconType} from './IconType';
-import {classes} from '../../utils';
import {JSX} from 'preact';
+import clsx from 'clsx';
type IntrinsicTag = keyof JSX.IntrinsicElements;
@@ -20,6 +20,6 @@ export function Icon<T extends IntrinsicTag = 'div'>({
}: IconProps<T>) {
const As = as as string;
return (
- <As className={classes(styles.icon, styles[type], className)} {...rest} />
+ <As className={clsx(styles.icon, styles[type], className)} {...rest} />
);
}
diff --git a/packages/ui/src/components/controls/IconButton.tsx b/packages/ui/src/components/controls/IconButton.tsx
index e602bc12..010032b3 100644
--- a/packages/ui/src/components/controls/IconButton.tsx
+++ b/packages/ui/src/components/controls/IconButton.tsx
@@ -1,7 +1,7 @@
import styles from './Controls.module.scss';
import {IconType} from './IconType';
-import {classes} from '../../utils';
+import clsx from 'clsx';
interface IconButtonProps {
icon: IconType;
@@ -13,7 +13,7 @@ export function IconButton({icon, onClick, title}: IconButtonProps) {
return (
<button
title={title}
- className={classes(styles.iconButton, styles.icon, styles[icon])}
+ className={clsx(styles.iconButton, styles.icon, styles[icon])}
type="button"
onClick={onClick}
/>
diff --git a/packages/ui/src/components/controls/IconCheckbox.tsx b/packages/ui/src/components/controls/IconCheckbox.tsx
index 9cd076ae..7c126753 100644
--- a/packages/ui/src/components/controls/IconCheckbox.tsx
+++ b/packages/ui/src/components/controls/IconCheckbox.tsx
@@ -1,7 +1,7 @@
import styles from './Controls.module.scss';
-import {classes} from '../../utils';
import {IconType} from './IconType';
+import clsx from 'clsx';
interface IconCheckboxProps {
iconOn?: IconType;
@@ -37,12 +37,12 @@ export function IconCheckbox({
/>
<label
title={titleOff && !checked ? titleOff : titleOn}
- className={classes(
+ className={clsx(
styles.icon,
styles.iconLabel,
- [styles.main, main],
- [styles[iconOn], checked || !iconOff],
- [styles[iconOff], iconOff && !checked],
+ main && styles.main,
+ (checked || !iconOff) && styles[iconOn],
+ iconOff && !checked && styles[iconOff],
)}
htmlFor={id}
/>
diff --git a/packages/ui/src/components/controls/Pill.tsx b/packages/ui/src/components/controls/Pill.tsx
index a2a80d77..73c46751 100644
--- a/packages/ui/src/components/controls/Pill.tsx
+++ b/packages/ui/src/components/controls/Pill.tsx
@@ -1,6 +1,6 @@
import styles from './Controls.module.scss';
import {ComponentChildren} from 'preact';
-import {classes} from '../../utils';
+import clsx from 'clsx';
export interface PillProps {
children: ComponentChildren;
@@ -20,7 +20,7 @@ export function Pill({
return (
<div
title={titleOff && !checked ? titleOff : titleOn}
- className={classes(styles.pill, [styles.checked, checked])}
+ className={clsx(styles.pill, checked && styles.checked)}
onClick={() => onChange(!checked)}
>
{children}
diff --git a/packages/ui/src/components/controls/Select.tsx b/packages/ui/src/components/controls/Select.tsx
index 56e78632..bd0ce9b0 100644
--- a/packages/ui/src/components/controls/Select.tsx
+++ b/packages/ui/src/components/controls/Select.tsx
@@ -1,5 +1,5 @@
import styles from './Controls.module.scss';
-import {classes} from '../../utils';
+import clsx from 'clsx';
export interface SelectProps<T> {
title?: string;
@@ -19,7 +19,7 @@ export function Select<T>({
return (
<select
title={title}
- className={classes(styles.select, className)}
+ className={clsx(styles.select, className)}
value={options.findIndex(option => option.value === value)}
onChange={event =>
onChange(
diff --git a/packages/ui/src/components/controls/Toggle.tsx b/packages/ui/src/components/controls/Toggle.tsx
index df5488c8..719e1017 100644
--- a/packages/ui/src/components/controls/Toggle.tsx
+++ b/packages/ui/src/components/controls/Toggle.tsx
@@ -1,5 +1,5 @@
import styles from './Controls.module.scss';
-import {classes} from '../../utils';
+import clsx from 'clsx';
export interface ToggleProps {
open?: boolean;
@@ -9,7 +9,7 @@ export interface ToggleProps {
export function Toggle({open, onToggle}: ToggleProps) {
return (
<div
- className={classes(styles.toggle, [styles.open, open])}
+ className={clsx(styles.toggle, open && styles.open)}
onClick={() => onToggle(!open)}
/>
);
diff --git a/packages/ui/src/components/fields/Layout.tsx b/packages/ui/src/components/fields/Layout.tsx
index cbe53ea8..1239b0ce 100644
--- a/packages/ui/src/components/fields/Layout.tsx
+++ b/packages/ui/src/components/fields/Layout.tsx
@@ -2,9 +2,9 @@ import styles from './Layout.module.scss';
import {ComponentChildren, JSX} from 'preact';
import {useRef, useState} from 'preact/hooks';
-import {classes} from '../../utils';
import {useFormattedNumber} from '../../hooks';
import {Toggle} from '../controls';
+import clsx from 'clsx';
export interface FieldSetProps {
children: ComponentChildren;
@@ -37,11 +37,10 @@ export function FieldValue({
}: FieldValueProps) {
return (
<div
- className={classes(
- styles.value,
- [styles.right, alignRight],
- [styles.grow, grow],
- )}
+ className={clsx(styles.value, {
+ [styles.right]: alignRight,
+ [styles.grow]: grow,
+ })}
{...props}
>
{children}
@@ -60,11 +59,10 @@ export function Field({label, copy, children}: FieldProps) {
return (
<div
- className={classes(
- styles.field,
- [styles.copy, !!copy],
- [styles.copied, copied],
- )}
+ className={clsx(styles.field, {
+ [styles.copy]: !!copy,
+ [styles.copied]: copied,
+ })}
onClick={() => {
if (!copy) return;
window.navigator.clipboard.writeText(copy);
@@ -97,12 +95,10 @@ export function FieldSurface({
}: FieldSurfaceProps) {
return (
<div
- className={classes(
- styles.surface,
- className,
- [styles.open, open],
- [styles.disabled, disabled],
- )}
+ className={clsx(styles.surface, className, {
+ [styles.open]: open,
+ [styles.disabled]: disabled,
+ })}
{...props}
/>
);
diff --git a/packages/ui/src/components/layout/ResizeableLayout.tsx b/packages/ui/src/components/layout/ResizeableLayout.tsx
index 96233874..f61ddba8 100644
--- a/packages/ui/src/components/layout/ResizeableLayout.tsx
+++ b/packages/ui/src/components/layout/ResizeableLayout.tsx
@@ -2,8 +2,8 @@ import styles from './ResizeableLayout.module.scss';
import {ComponentChild, JSX} from 'preact';
import {useCallback, useMemo, useRef} from 'preact/hooks';
-import {classes} from '../../utils';
import {useDrag, useStorage} from '../../hooks';
+import clsx from 'clsx';
interface ResizeableLayoutProps {
start: ComponentChild;
@@ -47,11 +47,10 @@ export function ResizeableLayout({
return (
<div
ref={containerRef}
- className={classes(
- styles.root,
- [styles.vertical, vertical],
- [styles.resizeable, resizeable],
- )}
+ className={clsx(styles.root, {
+ [styles.vertical]: vertical,
+ [styles.resizeable]: resizeable,
+ })}
>
<div className={styles.left} style={style}>
{start}
diff --git a/packages/ui/src/components/playback/PlaybackControls.tsx b/packages/ui/src/components/playback/PlaybackControls.tsx
index 0d9466ac..14fe18f6 100644
--- a/packages/ui/src/components/playback/PlaybackControls.tsx
+++ b/packages/ui/src/components/playback/PlaybackControls.tsx
@@ -5,8 +5,8 @@ import {useDocumentEvent, usePlayerState} from '../../hooks';
import {Select, Input} from '../controls';
import {Framerate} from './Framerate';
import {useCallback} from 'preact/hooks';
-import {classes} from '../../utils';
import {usePlayer} from '../../contexts';
+import clsx from 'clsx';
export function PlaybackControls() {
const player = usePlayer();
@@ -46,7 +46,7 @@ export function PlaybackControls() {
);
return (
- <div className={classes(styles.controls, [styles.disabled, state.render])}>
+ <div className={clsx(styles.controls, state.render && styles.disabled)}>
<Select
title="Playback speed"
options={[
diff --git a/packages/ui/src/components/tabs/Tabs.tsx b/packages/ui/src/components/tabs/Tabs.tsx
index 527561fc..443a3435 100644
--- a/packages/ui/src/components/tabs/Tabs.tsx
+++ b/packages/ui/src/components/tabs/Tabs.tsx
@@ -3,7 +3,7 @@ import styles from './Tabs.module.scss';
import {Icon, IconType} from '../controls';
import {ComponentChildren} from 'preact';
import {useCallback, useLayoutEffect} from 'preact/hooks';
-import {classes} from '../../utils';
+import clsx from 'clsx';
export enum TabType {
Link,
@@ -65,7 +65,7 @@ export function Tabs({children, tab, onToggle}: TabsProps) {
type={data.icon}
href={data.url}
id={data.id}
- className={classes(styles.tab, [styles.disabled, !data.url])}
+ className={clsx(styles.tab, !data.url && styles.disabled)}
/>
) : data.type === TabType.Pane ? (
<Icon
@@ -73,7 +73,7 @@ export function Tabs({children, tab, onToggle}: TabsProps) {
title={data.title}
id={data.id}
onClick={() => toggleTab(index)}
- className={classes(styles.tab, [styles.active, tab === index])}
+ className={clsx(styles.tab, tab === index && styles.active)}
>
{data.badge}
</Icon>
diff --git a/packages/ui/src/components/timeline/Timestamps.tsx b/packages/ui/src/components/timeline/Timestamps.tsx
index fc711f88..5ba6154e 100644
--- a/packages/ui/src/components/timeline/Timestamps.tsx
+++ b/packages/ui/src/components/timeline/Timestamps.tsx
@@ -2,7 +2,7 @@ import styles from './Timeline.module.scss';
import {useMemo} from 'preact/hooks';
import {useTimelineContext} from '../../contexts';
-import {classes} from '../../utils';
+import clsx from 'clsx';
export function Timestamps() {
const {
@@ -18,10 +18,9 @@ export function Timestamps() {
for (let i = firstVisibleFrame; i < lastVisibleFrame; i += clamped) {
timestamps.push(
<div
- className={classes(styles.timestamp, [
- styles.odd,
- segmentDensity > 0 && (i / segmentDensity) % 2 !== 0,
- ])}
+ className={clsx(styles.timestamp, {
+ [styles.odd]: segmentDensity > 0 && (i / segmentDensity) % 2 !== 0,
+ })}
style={{left: `${framesToPercents(i)}%`}}
key={i}
data-frame={i}
diff --git a/packages/ui/src/components/viewport/View.tsx b/packages/ui/src/components/viewport/View.tsx
index 74ea5e16..8c994994 100644
--- a/packages/ui/src/components/viewport/View.tsx
+++ b/packages/ui/src/components/viewport/View.tsx
@@ -17,7 +17,6 @@ import {ViewportContext, ViewportState} from './ViewportContext';
import {isInspectable} from '@motion-canvas/core/lib/scenes/Inspectable';
import {useInspection, usePlayer} from '../../contexts';
import {highlight} from '../animations';
-import {classes} from '../../utils';
const ZOOM_SPEED = 0.1;
diff --git a/packages/ui/src/utils/classes.ts b/packages/ui/src/utils/classes.ts
deleted file mode 100644
index d551c987..00000000
--- a/packages/ui/src/utils/classes.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-export function classes(...args: (string | [string, boolean])[]): string {
- let classList = '';
- for (const arg of args) {
- if (typeof arg === 'string') {
- classList += ' ' + arg;
- } else if (arg?.[1]) {
- classList += ' ' + arg[0];
- }
- }
-
- return classList;
-}
diff --git a/packages/ui/src/utils/index.ts b/packages/ui/src/utils/index.ts
index 5e924ee7..6b4cf4b3 100644
--- a/packages/ui/src/utils/index.ts
+++ b/packages/ui/src/utils/index.ts
@@ -1,3 +1,2 @@
-export * from './classes';
export * from './sourceMaps';
export * from './withLoader';