refactor: update text and link components to be polymorphic (#171)

This commit is contained in:
Razboy20
2024-03-15 22:06:36 -05:00
committed by GitHub
parent 61c43962fb
commit d04818ccd8
5 changed files with 55 additions and 38 deletions

View File

@@ -15,12 +15,16 @@ interface LinkItem {
const links: LinkItem[] = [
{
text: "Summer '24 Course Schedule",
url: 'https://utdirect.utexas.edu/apps/registrar/course_schedule/20242/',
text: "Fall '24 Course Schedule",
url: 'https://utdirect.utexas.edu/apps/registrar/course_schedule/20249/',
},
{
text: "Fall '24 Course Schedule",
url: 'https://utdirect.utexas.edu/apps/registrar/course_schedule/20236/',
text: "Summer '24 Course Schedule",
url: 'https://utdirect.utexas.edu/apps/registrar/course_schedule/20246/',
},
{
text: "Spring '24 Course Schedule",
url: 'https://utdirect.utexas.edu/apps/registrar/course_schedule/20242/',
},
{
text: 'Registration Info Sheet',

View File

@@ -7,31 +7,28 @@ import React from 'react';
import styles from './Link.module.scss';
type Props = Omit<TextProps, 'span'> & {
url?: string;
type Props = TextProps<'a'> & {
href?: string;
disabled?: boolean;
title?: string;
};
/**
* A reusable Text component with props that build on top of the design system for the extension
*/
export default function Link(props: PropsWithChildren<Props>): JSX.Element {
let passedProps = {
...props,
};
const { url } = props;
let { className, href, ...passedProps } = props;
if (url && !props.onClick) {
passedProps.onClick = () => background.openNewTab({ url });
if (href && !props.onClick) {
passedProps.onClick = () => background.openNewTab({ url: href });
}
const isDisabled = props.disabled || (!url && !props.onClick);
const isDisabled = props.disabled || (!href && !props.onClick);
return (
<Text
color='bluebonnet'
{...passedProps}
as='span'
as='a'
tabIndex={isDisabled ? -1 : 0}
className={clsx(
styles.link,
{

View File

@@ -1,34 +1,49 @@
import type { PropsOf, ReactTag } from '@headlessui/react/dist/types';
import clsx from 'clsx';
import type { PropsWithChildren } from 'react';
import type { ElementType, ReactNode } from 'react';
import React from 'react';
import styles from './Text.module.scss';
/**
* Props for the Text component.
*/
export type TextProps = {
variant?: Variant;
} & (
| (React.HTMLAttributes<HTMLSpanElement> & { as?: 'span' })
| (React.HTMLAttributes<HTMLDivElement> & { as: 'div' })
);
type PropsWeControl = 'as' | 'children';
type CleanProps<TTag extends ReactTag, TOmitableProps extends PropertyKey = never> = Omit<
PropsOf<TTag>,
TOmitableProps | PropsWeControl
>;
type OurProps<TTag extends ReactTag> = {
as?: TTag;
children?: ReactNode;
};
type AsProps<TTag extends ReactTag, TOverrides = {}> = CleanProps<TTag, keyof TOverrides> & OurProps<TTag> & TOverrides;
const variants = ['mini', 'small', 'p', 'h4', 'h3-course', 'h3', 'h2-course', 'h2', 'h1-course', 'h1'] as const;
type Variant = (typeof variants)[number];
/**
* Props for the Text component.
*/
export type TextProps<TTag extends ElementType = 'span'> = PropsOf<TTag>['className'] extends string
? AsProps<
TTag,
{
variant?: Variant;
}
>
: never;
/**
* A reusable Text component with props that build on top of the design system for the extension
*/
export default function Text({ variant, as, className, ...props }: PropsWithChildren<TextProps>): JSX.Element {
const mergedClassName = clsx(styles.text, styles[variant], className);
export default function Text<TTag extends ElementType = 'span'>({
as,
className,
variant,
...rest
}: TextProps<TTag>): JSX.Element {
const Comp = as || 'span';
const mergedClassName = clsx(styles.text, styles[variant || 'p'], className);
if (as === 'div') return <div className={mergedClassName} {...props} />;
return (
<span className={mergedClassName} {...props}>
{props.children}
</span>
);
return <Comp className={mergedClassName} {...rest} />;
}

View File

@@ -37,11 +37,11 @@ export default function RecruitmentBanner(): JSX.Element {
<div className={styles.container}>
<Text color='white'>
Interested in helping us develop UT Registration Plus? Check out our{' '}
<Link color='white' url={DISCORD_URL}>
<Link color='white' href={DISCORD_URL}>
Discord Server
</Link>{' '}
and{' '}
<Link color='white' url={GITHUB_URL}>
<Link color='white' href={GITHUB_URL}>
GitHub
</Link>
!