All files header.tsx

0% Statements 0/53
0% Branches 0/1
0% Functions 0/1
0% Lines 0/53

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54                                                                                                           
import { Component, IComponentPropsWithoutRef } from "@clutchd/component";
import { Flex, IFlexProps } from "@clutchd/flex";
import * as React from "react";

/**
 * Type to define `Header` element
 */
type IHeader = React.ElementRef<typeof Component.header>;

/**
 * Type to define `Header` props
 */
interface IHeaderProps extends IFlexProps {}

/**
 * Type to define `Header` props with html attributes
 */
interface IHeaderHtmlProps
  extends IHeaderProps,
    IComponentPropsWithoutRef<typeof Component.header> {}

/**
 * `Header` - A layout component designed to contain a page's header content. Renders as a `header` element
 * @param props `IHeaderHtmlProps` used to render this `Header`
 * @returns `Header` component
 */
const Header = React.forwardRef<IHeader, IHeaderHtmlProps>(
  (
    {
      children,
      flexDirection = "flex-row",
      justifyContent = "justify-between",
      ...props
    },
    forwardedRef,
  ) => {
    return (
      <Flex
        asChild
        flexDirection={flexDirection}
        justifyContent={justifyContent}
        {...props}
      >
        <header ref={forwardedRef}>{children}</header>
      </Flex>
    );
  },
);

Header.displayName = "Header";

export { Header };
export type { IHeader, IHeaderProps, IHeaderHtmlProps };