@cruk/cruk-react-components 2.0.1 → 3.0.0

package/lib/components/DateField/index.d.ts

@@ -1,32 +1,32 @@
-import { InputHTMLAttributes } from "react";
-export type DateFieldProps = InputHTMLAttributes<HTMLInputElement> & {
-    /** label text */
-    label: string;
-    /** hind text */
-    hintText?: string;
-    /** day field text value  */
-    day: string;
-    /** month field text value  */
-    month: string;
-    /** year field text value  */
-    year: string;
-    /** name passed to day field input element */
-    dayName?: string;
-    /** name passed to month field input element */
-    monthName?: string;
-    /** name passed to year field input element */
-    yearName?: string;
-    /** flag of error styling on day field */
-    dayHasError?: boolean;
-    /** flag of error styling on month field */
-    monthHasError?: boolean;
-    /** flag of error styling on year field */
-    yearHasError?: boolean;
-    /** error message text */
-    errorMessage?: string;
-};
-/**
- * To be used in forms entering dates like date of birth which are known dates and would take too long to get to with a date picker
- * */
-declare const DateField: ({ label, hintText, day, month, year, dayName, monthName, yearName, dayHasError, monthHasError, yearHasError, errorMessage, onChange, onBlur, onFocus, disabled, required, }: DateFieldProps) => JSX.Element;
-export default DateField;
+import { InputHTMLAttributes } from "react";
+export type DateFieldProps = InputHTMLAttributes<HTMLInputElement> & {
+    /** label text */
+    label: string;
+    /** hind text */
+    hintText?: string;
+    /** day field text value  */
+    day: string;
+    /** month field text value  */
+    month: string;
+    /** year field text value  */
+    year: string;
+    /** name passed to day field input element */
+    dayName?: string;
+    /** name passed to month field input element */
+    monthName?: string;
+    /** name passed to year field input element */
+    yearName?: string;
+    /** flag of error styling on day field */
+    dayHasError?: boolean;
+    /** flag of error styling on month field */
+    monthHasError?: boolean;
+    /** flag of error styling on year field */
+    yearHasError?: boolean;
+    /** error message text */
+    errorMessage?: string;
+};
+/**
+ * To be used in forms entering dates like date of birth which are known dates and would take too long to get to with a date picker
+ * */
+declare const DateField: ({ label, hintText, day, month, year, dayName, monthName, yearName, dayHasError, monthHasError, yearHasError, errorMessage, onChange, onBlur, onFocus, disabled, required, }: DateFieldProps) => JSX.Element;
+export default DateField;

package/lib/components/DateField/styles.d.ts

@@ -1,4 +1,9 @@
-export declare const Fieldset: import("styled-components").StyledComponent<"fieldset", any, {}, never>;
-export declare const DateTextFieldWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
-export declare const LargeDateTextFieldWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
-export declare const ErrorTextWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
+import { ThemeType } from "../../types";
+type ThemeProps = {
+    theme: ThemeType;
+};
+export declare const Fieldset: import("styled-components").StyledComponent<"fieldset", any, {}, never>;
+export declare const DateTextFieldWrapper: import("styled-components").StyledComponent<"div", any, ThemeProps, never>;
+export declare const LargeDateTextFieldWrapper: import("styled-components").StyledComponent<"div", any, ThemeProps, never>;
+export declare const ErrorTextWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
+export {};

package/lib/components/Divider.d.ts

@@ -1,6 +1,6 @@
-import { ReactNode } from "react";
-type DividerProps = {
-    children?: ReactNode;
-};
-export declare const Divider: ({ children }: DividerProps) => JSX.Element;
-export default Divider;
+import { ReactNode } from "react";
+type DividerProps = {
+    children?: ReactNode;
+};
+export declare const Divider: ({ children }: DividerProps) => JSX.Element;
+export default Divider;

package/lib/components/ErrorText/ErrorText.stories.d.ts

@@ -1,7 +1,16 @@
-import { Story, Meta } from "@storybook/react";
-import { ErrorTextProps } from ".";
-declare const _default: Meta<ErrorTextProps>;
-export default _default;
-export declare const ErrorTextDefault: Story;
-export declare const SU2CErrorText: Story;
-export declare const BowelbabeErrorText: Story;
+import React from "react";
+import { StoryObj } from "@storybook/react";
+import ErrorText, { ErrorTextProps } from ".";
+declare const _default: {
+    title: string;
+    component: React.FunctionComponent<ErrorTextProps>;
+    args: {
+        children: string;
+    };
+    tags: string[];
+};
+export default _default;
+type Story = StoryObj<typeof ErrorText>;
+export declare const ErrorTextDefault: Story;
+export declare const ErrorTextSU2C: Story;
+export declare const ErrorTextBowelbabe: Story;

package/lib/components/ErrorText/ErrorText.test.cypress.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/components/ErrorText/index.d.ts

@@ -1,13 +1,13 @@
-import React, { FunctionComponent, HTMLAttributes } from "react";
-import { SpacingProps } from "../Spacing";
-export type ErrorTextProps = SpacingProps & HTMLAttributes<HTMLElement> & {
-    as?: React.ElementType;
-};
-/**
- *
- * To be used in forms for inline validation. Applies styling and accessibility attribute so that it will be read by screen readers.
- *
- * Please be aware that some input components already have this component built in and can be passed an "errorMessage" prop
- */
-declare const ErrorText: FunctionComponent<ErrorTextProps>;
-export default ErrorText;
+import React, { FunctionComponent, HTMLAttributes } from "react";
+import { SpacingProps } from "../Spacing";
+export type ErrorTextProps = SpacingProps & HTMLAttributes<HTMLElement> & {
+    as?: React.ElementType;
+};
+/**
+ *
+ * To be used in forms for inline validation. Applies styling and accessibility attribute so that it will be read by screen readers.
+ *
+ * Please be aware that some input components already have this component built in and can be passed an "errorMessage" prop
+ */
+declare const ErrorText: FunctionComponent<ErrorTextProps>;
+export default ErrorText;

package/lib/components/ErrorText/styles.d.ts

@@ -1,3 +1,7 @@
-/// <reference types="react" />
-export declare const StyledErrorText: import("styled-components").StyledComponent<import("react").FunctionComponent<import("../Text").TextProps>, any, {}, never>;
-export default StyledErrorText;
+/// <reference types="react" />
+import { ThemeType } from "../../types";
+type ThemeProps = {
+    theme: ThemeType;
+};
+export declare const StyledErrorText: import("styled-components").StyledComponent<import("react").FunctionComponent<import("../Text").TextProps>, any, ThemeProps, never>;
+export default StyledErrorText;

package/lib/components/Flex.d.ts

@@ -1,3 +1,3 @@
-import { SpacingProps } from "./Spacing";
-declare const Flex: import("styled-components").StyledComponent<"div", any, SpacingProps, never>;
-export default Flex;
+import { SpacingProps } from "./Spacing";
+declare const Flex: import("styled-components").StyledComponent<"div", any, SpacingProps, never>;
+export default Flex;

package/lib/components/Fontface.d.ts

@@ -1,2 +1,2 @@
-export declare const fontFaceStyleString: string;
-export default fontFaceStyleString;
+export declare const fontFaceStyleString: string;
+export default fontFaceStyleString;

package/lib/components/Footer/Footer.stories.d.ts

@@ -1,7 +1,13 @@
-import { Story, Meta } from "@storybook/react";
-import { FooterProps } from ".";
-declare const _default: Meta<FooterProps>;
-export default _default;
-export declare const FooterDefault: Story;
-export declare const SU2CFooter: Story;
-export declare const BowelbabeFooter: Story;
+import { StoryObj } from "@storybook/react";
+import Footer, { FooterProps } from ".";
+declare const _default: {
+    title: string;
+    component: ({ children, middleSection }: FooterProps) => JSX.Element;
+    render: (args: FooterProps) => JSX.Element;
+    tags: string[];
+};
+export default _default;
+type Story = StoryObj<typeof Footer>;
+export declare const FooterDefault: Story;
+export declare const FooterSU2C: Story;
+export declare const FooterBowelbabe: Story;

package/lib/components/Footer/Footer.test.cypress.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/components/Footer/index.d.ts

@@ -1,11 +1,11 @@
-import { ReactNode, HTMLAttributes } from "react";
-export type FooterProps = HTMLAttributes<HTMLElement> & {
-    /** used to customise text in middle section, it could also be react element, this is not to be confused with the component children which is primarily for the links in the footer */
-    middleSection?: ReactNode;
-    children?: ReactNode;
-};
-/**
- * There should be only one footer component at the bottom of the body of each page. Links can be passed as children
- * */
-export declare const Footer: ({ children, middleSection }: FooterProps) => JSX.Element;
-export default Footer;
+import { ReactNode, HTMLAttributes } from "react";
+export type FooterProps = HTMLAttributes<HTMLElement> & {
+    /** used to customise text in middle section, it could also be react element, this is not to be confused with the component children which is primarily for the links in the footer */
+    middleSection?: ReactNode;
+    children?: ReactNode;
+};
+/**
+ * There should be only one footer component at the bottom of the body of each page. Links can be passed as children
+ * */
+export declare const Footer: ({ children, middleSection }: FooterProps) => JSX.Element;
+export default Footer;

package/lib/components/Footer/styles.d.ts

@@ -1,11 +1,16 @@
-export declare const StyledFooter: import("styled-components").StyledComponent<"footer", any, {}, never>;
-export declare const FooterContentWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
-export declare const FooterSection: import("styled-components").StyledComponent<"div", any, {}, never>;
-export declare const FooterSectionLogo: import("styled-components").StyledComponent<"div", any, {}, never>;
-export declare const FooterSectionLinks: import("styled-components").StyledComponent<"div", any, {}, never>;
-export declare const StyledNav: import("styled-components").StyledComponent<"nav", any, {}, never>;
-export declare const StyledUL: import("styled-components").StyledComponent<"ul", any, {}, never>;
-export declare const StyledLI: import("styled-components").StyledComponent<"li", any, {}, never>;
-export declare const FooterSectionAddress: import("styled-components").StyledComponent<"div", any, {}, never>;
-export declare const StyledRegulatorLogo: import("styled-components").StyledComponent<"img", any, {}, never>;
-export declare const StyledAddress: import("styled-components").StyledComponent<"address", any, {}, never>;
+import { ThemeType } from "../../types";
+type ThemeProps = {
+    theme: ThemeType;
+};
+export declare const StyledFooter: import("styled-components").StyledComponent<"footer", any, ThemeProps, never>;
+export declare const FooterContentWrapper: import("styled-components").StyledComponent<"div", any, ThemeProps, never>;
+export declare const FooterSection: import("styled-components").StyledComponent<"div", any, ThemeProps, never>;
+export declare const FooterSectionLogo: import("styled-components").StyledComponent<"div", any, ThemeProps, never>;
+export declare const FooterSectionLinks: import("styled-components").StyledComponent<"div", any, ThemeProps, never>;
+export declare const StyledNav: import("styled-components").StyledComponent<"nav", any, ThemeProps, never>;
+export declare const StyledUL: import("styled-components").StyledComponent<"ul", any, {}, never>;
+export declare const StyledLI: import("styled-components").StyledComponent<"li", any, ThemeProps, never>;
+export declare const FooterSectionAddress: import("styled-components").StyledComponent<"div", any, ThemeProps, never>;
+export declare const StyledRegulatorLogo: import("styled-components").StyledComponent<"img", any, {}, never>;
+export declare const StyledAddress: import("styled-components").StyledComponent<"address", any, {}, never>;
+export {};

package/lib/components/GlobalStyle.d.ts

@@ -1,9 +1,9 @@
-/// <reference types="react" />
-declare const _default: import("react").ForwardRefExoticComponent<{
-    ref?: import("react").Ref<import("react").Component<import("styled-components").ThemedGlobalStyledClassProps<{}, import("styled-components").DefaultTheme>, any, any>> | undefined;
-    suppressMultiMountWarning?: boolean | undefined;
-    key?: import("react").Key | null | undefined;
-} & {
-    theme?: any;
-}>;
-export default _default;
+/// <reference types="react" />
+declare const _default: import("react").ForwardRefExoticComponent<{
+    ref?: import("react").Ref<import("react").Component<import("styled-components").ThemedGlobalStyledClassProps<{}, import("styled-components").DefaultTheme>, any, any>> | undefined;
+    suppressMultiMountWarning?: boolean | undefined;
+    key?: import("react").Key | null | undefined;
+} & {
+    theme?: any;
+}>;
+export default _default;

package/lib/components/GlobalStyleNoFontFace.d.ts

@@ -1,9 +1,9 @@
-/// <reference types="react" />
-declare const _default: import("react").ForwardRefExoticComponent<{
-    ref?: import("react").Ref<import("react").Component<import("styled-components").ThemedGlobalStyledClassProps<{}, import("styled-components").DefaultTheme>, any, any>> | undefined;
-    suppressMultiMountWarning?: boolean | undefined;
-    key?: import("react").Key | null | undefined;
-} & {
-    theme?: any;
-}>;
-export default _default;
+/// <reference types="react" />
+declare const _default: import("react").ForwardRefExoticComponent<{
+    ref?: import("react").Ref<import("react").Component<import("styled-components").ThemedGlobalStyledClassProps<{}, import("styled-components").DefaultTheme>, any, any>> | undefined;
+    suppressMultiMountWarning?: boolean | undefined;
+    key?: import("react").Key | null | undefined;
+} & {
+    theme?: any;
+}>;
+export default _default;

package/lib/components/Header/Header.stories.d.ts

@@ -1,7 +1,20 @@
-import { Story, Meta } from "@storybook/react";
-import { HeaderProps } from ".";
-declare const _default: Meta<HeaderProps>;
-export default _default;
-export declare const HeaderDefault: Story<HeaderProps>;
-export declare const SU2CHeader: Story;
-export declare const BowelbabeHeader: Story;
+import { StoryObj } from "@storybook/react";
+import Header, { HeaderProps } from ".";
+declare const _default: {
+    title: string;
+    component: ({ isSticky, siteSlogan, logoAltText, logoImageSrc, logoLinkTitle, logoLinkUrl, fullWidth, children, }: HeaderProps) => JSX.Element;
+    args: {
+        siteSlogan: string;
+        children: JSX.Element;
+        isSticky: boolean;
+        fullWidth: boolean;
+    };
+    tags: string[];
+};
+export default _default;
+type Story = StoryObj<typeof Header>;
+export declare const HeaderDefault: Story;
+export declare const HeaderFullWidth: Story;
+export declare const HeaderSticky: Story;
+export declare const HeaderSU2C: Story;
+export declare const HeaderBowelbabe: Story;

package/lib/components/Header/Header.test.cypress.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/components/Header/index.d.ts

@@ -1,37 +1,37 @@
-import { HTMLAttributes, ReactNode } from "react";
-export type HeaderProps = HTMLAttributes<HTMLElement> & {
-    /** flag which make header fixed to the top even when scrolling */
-    isSticky?: boolean;
-    /** text in the middle of the header */
-    siteSlogan?: string;
-    /** text to explain the content of the icon for a11y usually a description of where the link will take you */
-    logoAltText?: string;
-    /** header logo image url */
-    logoImageSrc?: string;
-    /** title of the header image component, this is mainly for the tooltip text on hover */
-    logoLinkTitle?: string;
-    /** the url of the logo link */
-    logoLinkUrl?: string;
-    /** instead of the contents of the header being centered to max width as defined in theme it is 100% width fo viewport */
-    fullWidth?: boolean;
-    children?: ReactNode;
-};
-/**
- * There should be only one header component near or at the top of the body of each page.
- *
- * ### Logos
- * It is recommended that logo images are at least 80px high if they are not SVGs and that the logo is still clearly legible when reduced to 40px high for mobile.
- * It is also recommended that the logo width doesn't exceed 350px. If you need a wide logo that is shorter than 80px to keep the aspect ratio please make sure that the logo is centered with transparent space at the top and bottom and still 80px high.
- *
- * ### Site Slogan Text (optional)
- * This is a single line of text and the character limit depends on the theme, logo and children width. This is only visible on desktop at the top of the page
- *
- * ### Right section (optional)
- * This has been kept quite open you can place any child elements in here but ideally it is narrow and its height is 50px or smaller.
- *
- * ### Accessability
- * There is a hidden skip link in the header which will only reveals itself on the first tab and to screen readers. This link helps users skip to the main page content, however this will only work with there is an element with an id of 'main' which the developer should create for every page.
- *
- */
-export declare const Header: ({ isSticky, siteSlogan, logoAltText, logoImageSrc, logoLinkTitle, logoLinkUrl, fullWidth, children, }: HeaderProps) => JSX.Element;
-export default Header;
+import { HTMLAttributes, ReactNode } from "react";
+export type HeaderProps = HTMLAttributes<HTMLElement> & {
+    /** flag which make header fixed to the top even when scrolling */
+    isSticky?: boolean;
+    /** text in the middle of the header */
+    siteSlogan?: string;
+    /** text to explain the content of the icon for a11y usually a description of where the link will take you */
+    logoAltText?: string;
+    /** header logo image url */
+    logoImageSrc?: string;
+    /** title of the header image component, this is mainly for the tooltip text on hover */
+    logoLinkTitle?: string;
+    /** the url of the logo link */
+    logoLinkUrl?: string;
+    /** instead of the contents of the header being centered to max width as defined in theme it is 100% width fo viewport */
+    fullWidth?: boolean;
+    children?: ReactNode;
+};
+/**
+ * There should be only one header component near or at the top of the body of each page.
+ *
+ * ### Logos
+ * It is recommended that logo images are at least 80px high if they are not SVGs and that the logo is still clearly legible when reduced to 40px high for mobile.
+ * It is also recommended that the logo width doesn't exceed 350px. If you need a wide logo that is shorter than 80px to keep the aspect ratio please make sure that the logo is centered with transparent space at the top and bottom and still 80px high.
+ *
+ * ### Site Slogan Text (optional)
+ * This is a single line of text and the character limit depends on the theme, logo and children width. This is only visible on desktop at the top of the page
+ *
+ * ### Right section (optional)
+ * This has been kept quite open you can place any child elements in here but ideally it is narrow and its height is 50px or smaller.
+ *
+ * ### Accessability
+ * There is a hidden skip link in the header which will only reveals itself on the first tab and to screen readers. This link helps users skip to the main page content, however this will only work with there is an element with an id of 'main' which the developer should create for every page.
+ *
+ */
+export declare const Header: ({ isSticky, siteSlogan, logoAltText, logoImageSrc, logoLinkTitle, logoLinkUrl, fullWidth, children, }: HeaderProps) => JSX.Element;
+export default Header;

package/lib/components/Header/styles.d.ts

@@ -1,31 +1,37 @@
-import { ThemeType } from "../../types";
-export declare const StyledHeader: import("styled-components").StyledComponent<"header", any, {
-    isSmall?: boolean | undefined;
-    isSticky?: boolean | undefined;
-    fullWidth?: boolean | undefined;
-}, never>;
-export declare const HeaderStickyPlaceHolder: import("styled-components").StyledComponent<"div", any, {}, never>;
-type HeaderStickyProps = {
-    isSmall?: boolean;
-    isSticky?: boolean;
-    theme: ThemeType;
-};
-export declare const HeaderStickyContainer: import("styled-components").StyledComponent<"div", any, HeaderStickyProps, never>;
-export declare const HeaderMainContent: import("styled-components").StyledComponent<"div", any, {
-    fullWidth?: boolean | undefined;
-}, never>;
-export declare const Logo: import("styled-components").StyledComponent<"img", any, {}, never>;
-type LogoWrapperProps = {
-    isSmall?: boolean;
-    isSticky?: boolean;
-};
-export declare const LogoWrapper: import("styled-components").StyledComponent<"div", any, LogoWrapperProps, never>;
-export declare const StyledLink: import("styled-components").StyledComponent<"a", any, {}, never>;
-export declare const SkipToMain: import("styled-components").StyledComponent<"a", any, {}, never>;
-export declare const Tagline: import("styled-components").StyledComponent<"p", any, {
-    isSmall?: boolean | undefined;
-    isSticky?: boolean | undefined;
-}, never>;
-export declare const ChildWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
-export declare const ChildInner: import("styled-components").StyledComponent<"div", any, {}, never>;
-export {};
+import { ThemeType } from "../../types";
+type StyledHeaderProps = {
+    theme: ThemeType;
+    isSmall?: boolean;
+    isSticky?: boolean;
+    fullWidth?: boolean;
+};
+export declare const StyledHeader: import("styled-components").StyledComponent<"header", any, {
+    isSmall?: boolean | undefined;
+    isSticky?: boolean | undefined;
+    fullWidth?: boolean | undefined;
+}, never>;
+export declare const HeaderStickyPlaceHolder: import("styled-components").StyledComponent<"div", any, StyledHeaderProps, never>;
+type HeaderStickyProps = {
+    isSmall?: boolean;
+    isSticky?: boolean;
+    theme: ThemeType;
+};
+export declare const HeaderStickyContainer: import("styled-components").StyledComponent<"div", any, HeaderStickyProps, never>;
+export declare const HeaderMainContent: import("styled-components").StyledComponent<"div", any, {
+    fullWidth?: boolean | undefined;
+}, never>;
+export declare const Logo: import("styled-components").StyledComponent<"img", any, {}, never>;
+type LogoWrapperProps = {
+    isSmall?: boolean;
+    isSticky?: boolean;
+};
+export declare const LogoWrapper: import("styled-components").StyledComponent<"div", any, LogoWrapperProps, never>;
+export declare const StyledLink: import("styled-components").StyledComponent<"a", any, {}, never>;
+export declare const SkipToMain: import("styled-components").StyledComponent<"a", any, StyledHeaderProps, never>;
+export declare const Tagline: import("styled-components").StyledComponent<"p", any, {
+    isSmall?: boolean | undefined;
+    isSticky?: boolean | undefined;
+}, never>;
+export declare const ChildWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
+export declare const ChildInner: import("styled-components").StyledComponent<"div", any, {}, never>;
+export {};

package/lib/components/Heading/Heading.stories.d.ts

@@ -1,25 +1,31 @@
-import { Story, Meta } from "@storybook/react";
-import { HeadingProps } from ".";
-declare const _default: Meta<HeadingProps>;
-export default _default;
-export declare const DefaultHeading: Story;
-export declare const HeadingSize: Story;
-export declare const HeadingAligned: Story;
-export declare const H1: Story;
-export declare const H2: Story;
-export declare const H3: Story;
-export declare const H4: Story;
-export declare const H5: Story;
-export declare const H6: Story;
-export declare const SU2C_H1: Story;
-export declare const SU2C_H2: Story;
-export declare const SU2C_H3: Story;
-export declare const SU2C_H4: Story;
-export declare const SU2C_H5: Story;
-export declare const SU2C_H6: Story;
-export declare const Bowelbabe_H1: Story;
-export declare const Bowelbabe_H2: Story;
-export declare const Bowelbabe_H3: Story;
-export declare const Bowelbabe_H4: Story;
-export declare const Bowelbabe_H5: Story;
-export declare const Bowelbabe_H6: Story;
+import { StoryObj } from "@storybook/react";
+import Heading, { HeadingProps } from ".";
+declare const _default: {
+    title: string;
+    component: ({ h1, h2, h3, h4, h5, h6, ...props }: HeadingProps) => JSX.Element;
+    args: {};
+    tags: string[];
+};
+export default _default;
+type Story = StoryObj<typeof Heading>;
+export declare const DefaultHeading: Story;
+export declare const HeadingSize: Story;
+export declare const HeadingAligned: Story;
+export declare const H1: Story;
+export declare const H2: Story;
+export declare const H3: Story;
+export declare const H4: Story;
+export declare const H5: Story;
+export declare const H6: Story;
+export declare const H1SU2C: Story;
+export declare const H2SU2C: Story;
+export declare const H3SU2C: Story;
+export declare const H4SU2C: Story;
+export declare const H5SU2C: Story;
+export declare const H6SU2C: Story;
+export declare const H1Bowelbabe: Story;
+export declare const H2Bowelbabe: Story;
+export declare const H3Bowelbabe: Story;
+export declare const H4Bowelbabe: Story;
+export declare const H5Bowelbabe: Story;
+export declare const H6Bowelbabe: Story;

package/lib/components/Heading/Heading.test.cypress.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/lib/components/Heading/index.d.ts

@@ -1,32 +1,32 @@
-import { HTMLAttributes, ElementType } from "react";
-import { SpacingProps } from "../Spacing";
-import { FontSizeType, WordBreakType, OverflowWrapType } from "../../types";
-export type HeadingProps = SpacingProps & HTMLAttributes<HTMLElement> & {
-    h1?: boolean;
-    h2?: boolean;
-    h3?: boolean;
-    h4?: boolean;
-    h5?: boolean;
-    h6?: boolean;
-    /** font size FontSizeType t-shirt sizes  */
-    textSize?: FontSizeType;
-    /** horizontal alignment of text */
-    textAlign?: "left" | "right" | "center";
-    /** color of text */
-    textColor?: string;
-    /** styled-component polymorphic feature so you take the styling of a header and cast the component to be a "span" for example */
-    as?: ElementType;
-    /** word-break behavior */
-    wordBreak?: WordBreakType;
-    /** overflow-wrap behavior */
-    overflowWrap?: OverflowWrapType;
-};
-/**
- *
- * Use headings consistently to create a clear hierarchy throughout your service.
-Markup headings semantically using the appropriate <h#> level HTML element and
-use the corresponding heading class (h1, h2, h3, ....). Write all headings in sentence case. Heading differs from the Text component by using a different font-family and it changes the font size according to the screen width breakpoints.
- *
- */
-declare const Heading: ({ h1, h2, h3, h4, h5, h6, ...props }: HeadingProps) => JSX.Element;
-export default Heading;
+import { HTMLAttributes, ElementType } from "react";
+import { SpacingProps } from "../Spacing";
+import { FontSizeType, WordBreakType, OverflowWrapType } from "../../types";
+export type HeadingProps = SpacingProps & HTMLAttributes<HTMLElement> & {
+    h1?: boolean;
+    h2?: boolean;
+    h3?: boolean;
+    h4?: boolean;
+    h5?: boolean;
+    h6?: boolean;
+    /** font size FontSizeType t-shirt sizes  */
+    textSize?: FontSizeType;
+    /** horizontal alignment of text */
+    textAlign?: "left" | "right" | "center";
+    /** color of text */
+    textColor?: string;
+    /** styled-component polymorphic feature so you take the styling of a header and cast the component to be a "span" for example */
+    as?: ElementType;
+    /** word-break behavior */
+    wordBreak?: WordBreakType;
+    /** overflow-wrap behavior */
+    overflowWrap?: OverflowWrapType;
+};
+/**
+ *
+ * Use headings consistently to create a clear hierarchy throughout your service.
+Markup headings semantically using the appropriate <h#> level HTML element and
+use the corresponding heading class (h1, h2, h3, ....). Write all headings in sentence case. Heading differs from the Text component by using a different font-family and it changes the font size according to the screen width breakpoints.
+ *
+ */
+declare const Heading: ({ h1, h2, h3, h4, h5, h6, ...props }: HeadingProps) => JSX.Element;
+export default Heading;