Heading With Anchor

Add anchor for every heading.

Heading 1

Installation

1

Install the package if you do not have it.

npm i @radix-ui/react-slot class-variance-authority
2

Copy and paste the following code into your project.

import { cn } from '@/lib/utils';
import { Slot } from '@radix-ui/react-slot';
import { cva, type VariantProps } from 'class-variance-authority';
import React from 'react';
import Anchor from './anchor';
const headingVariants = cva('font-bold text-primary', {
  variants: {
    variant: {
      h1: 'leading-14 text-4xl lg:text-5xl',
      h2: 'leading-14 text-3xl lg:text-4xl',
      h3: 'leading-10 text-2xl lg:text-3xl',
      h4: 'leading-8 text-xl lg:text-2xl',
      h5: 'leading-8 text-lg lg:text-xl',
      h6: 'leading-7 text-sm lg:text-base',
      p: 'leading-5 text-lg lg:text-xl font-normal',
    },
  },
  defaultVariants: {
    variant: 'h6',
  },
});

type BaseHeadingProps = {
  children?: React.ReactNode;
  variant?: string;
  className?: string;
  asChild?: boolean;
  anchor?: string;
  args?: HeadingArgs;
} & React.HTMLAttributes<HTMLHeadingElement> &
  VariantProps<typeof headingVariants>;

type HeadingArgs = {
  alignAnchor?: 'close' | 'spaced';
  alwaysDisplay?: boolean;
  disableCopyToClipboard?: boolean;
};

const BaseHeading = ({
  children,
  className,
  variant = 'h6',
  asChild = false,
  anchor,
  args: { alignAnchor = 'close', alwaysDisplay = false, disableCopyToClipboard = false } = {},
  ...props
}: BaseHeadingProps) => {
  const Comp = asChild ? Slot : variant;
  return (
    <div className="group">
      <Comp
        id={anchor}
        {...props}
        className={cn(
          anchor && 'flex scroll-m-20 items-center', // modify `scroll-m-20` according to your header height.
          headingVariants({ variant, className }),
          alignAnchor === 'spaced' && 'justify-between',
        )}
      >
        {children}
        {anchor && (
          <Anchor
            anchor={anchor}
            alwaysDisplay={alwaysDisplay}
            disableCopyToClipboard={disableCopyToClipboard}
          />
        )}
      </Comp>
    </div>
  );
};

type TypographyProps = Omit<BaseHeadingProps, 'variant'>;

const H1 = (props: TypographyProps) => {
  return <BaseHeading {...props} variant="h1" />;
};

const H2 = (props: TypographyProps) => {
  return <BaseHeading {...props} variant="h2" />;
};

const H3 = (props: TypographyProps) => {
  return <BaseHeading {...props} variant="h3" />;
};

const H4 = (props: TypographyProps) => {
  return <BaseHeading {...props} variant="h4" />;
};

const H5 = (props: TypographyProps) => {
  return <BaseHeading {...props} variant="h5" />;
};

const H6 = (props: TypographyProps) => {
  return <BaseHeading {...props} variant="h6" />;
};

const P = (props: TypographyProps) => {
  return <BaseHeading {...props} variant="p" />;
};

export { H1, H2, H3, H4, H5, H6, P };
3

Modify `scroll-m-20` according to your header height and `Link` to `a` if you are not using Next.js

4

Update the import paths to match your project setup.

Usage

Heading 1

Heading 1 without anchor

Heading 2

Heading 2 without anchor

Heading 3

Heading 3 without anchor

Heading 4

Heading 4 without anchor

Heading 5
Heading 5 without anchor
Heading 6
Heading 6 without anchor
Buy Me A Coffee