aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/atoms/lists/list/list.tsx
blob: 6e5843301b7efc1506fd93e54d9cb50ce94a66bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight
import {
  forwardRef,
  type CSSProperties,
  type HTMLAttributes,
  type OlHTMLAttributes,
  type ReactNode,
  type ForwardedRef,
} from 'react';
import type { Spacing } from '../../../../types';
import styles from './list.module.scss';

type OrderedListProps = Omit<OlHTMLAttributes<HTMLOListElement>, 'children'>;

type UnorderedListProps = Omit<HTMLAttributes<HTMLUListElement>, 'children'>;

type BaseListProps<O extends boolean, H extends boolean> = O extends true
  ? OrderedListProps
  : H extends true
  ? OrderedListProps
  : UnorderedListProps;

type AdditionalProps<O extends boolean, H extends boolean> = {
  /**
   * An array of list items.
   */
  children: ReactNode;
  /**
   * Should the items marker be hidden?
   *
   * @default false
   */
  hideMarker?: boolean;
  /**
   * Should the list be ordered and hierarchical?
   *
   * @default false
   */
  isHierarchical?: H;
  /**
   * Should the list be inlined?
   *
   * @default false
   */
  isInline?: boolean;
  /**
   * Should the list be ordered?
   *
   * @default false
   */
  isOrdered?: O;
  /**
   * Define the spacing between list items.
   *
   * @default null
   */
  spacing?: Spacing | null;
};

type BuildClassNameConfig<O extends boolean, H extends boolean> = Pick<
  BaseListProps<O, H>,
  'className'
> &
  Pick<
    AdditionalProps<O, H>,
    'hideMarker' | 'isHierarchical' | 'isInline' | 'isOrdered'
  >;

const buildClassName = <O extends boolean, H extends boolean>({
  className = '',
  hideMarker,
  isHierarchical,
  isInline,
  isOrdered,
}: BuildClassNameConfig<O, H>) => {
  const orderedClassName = isHierarchical
    ? 'list--hierarchical'
    : 'list--ordered';
  const classNames: string[] = [
    isHierarchical || isOrdered ? orderedClassName : 'list--unordered',
    isInline ? 'list--inline' : 'list--stack',
    hideMarker ? 'list--no-marker' : 'list--has-marker',
    className,
  ].map((key) => styles[key]);

  if (className) classNames.push(className);

  return classNames.join(' ');
};

export type ListProps<O extends boolean, H extends boolean> = BaseListProps<
  O,
  H
> &
  AdditionalProps<O, H>;

const ListWithRef = <O extends boolean, H extends boolean>(
  {
    className,
    children,
    hideMarker = false,
    isHierarchical,
    isInline = false,
    isOrdered,
    spacing = null,
    style,
    ...props
  }: ListProps<O, H>,
  ref: ForwardedRef<
    O extends true
      ? HTMLOListElement
      : H extends true
      ? HTMLOListElement
      : HTMLUListElement
  >
) => {
  const itemSpacing = spacing === null ? 0 : `var(--spacing-${spacing})`;
  const listClass = buildClassName({
    className,
    hideMarker,
    isHierarchical,
    isInline,
    isOrdered,
  });
  const listStyles = {
    ...style,
    '--itemSpacing': itemSpacing,
  } as CSSProperties;

  return isHierarchical || isOrdered ? (
    <ol
      {...props}
      className={listClass}
      ref={ref as ForwardedRef<HTMLOListElement>}
      style={listStyles}
    >
      {children}
    </ol>
  ) : (
    <ul {...props} className={listClass} ref={ref} style={listStyles}>
      {children}
    </ul>
  );
};

/**
 * List component
 *
 * Render either an ordered or an unordered list.
 */
export const List = forwardRef(ListWithRef);
span>.hooks.add('before-tokenize', function (e) { o.buildPlaceholders(e, 'jinja2', n); }), e.hooks.add('after-tokenize', function (e) { o.tokenizePlaceholders(e, 'jinja2'); }); })(Prism);