Skip to content
Snippets Groups Projects
components.d.ts 47.1 KiB
Newer Older
Markus Kaarto's avatar
Markus Kaarto committed
    /**
     * Aria label for the element
     */
    ariaLabel?: string;
    /**
     * Custom classes added to button element.
     */
    buttonClasses?: string;
    /**
     * Button type. Defaults to submit.
     */
    buttonType?: string;
Markus Kaarto's avatar
Markus Kaarto committed
    /**
     * Use this to programmatically disable the button, matches the native button functionality
     */
    disabled?: boolean;
    /**
     * Icon to use on the left side
     */
    icon?: string;
    /**
     * Icon to use on the right side
     */
    iconRight?: string;
    /**
     * Use only with url property. Sets the
     */
    isExternal?: boolean;
    /**
     * Size (height) of the button. Normal: 44px, large: 48px
     */
    size?: 'normal' | 'large';
Markus Kaarto's avatar
Markus Kaarto committed
    /**
     * deprecated, use disabled boolean value
     */
    state?: 'enabled' | 'disabled';
Markus Kaarto's avatar
Markus Kaarto committed
    /**
     * Set this on if an anchor tag is required instead of a button.
     */
    url?: string;
    /**
     * The element variant. Defaults to primary
     */
    variant?: ButtonVariants;
  }
    headerstyle?: string;
Markus Kaarto's avatar
Markus Kaarto committed
    isExternal?: boolean;
    linkContent?: string;
Markus Kaarto's avatar
Markus Kaarto committed
    url?: string;
Ekaterina Kondareva's avatar
Ekaterina Kondareva committed
    variant?: CtaLinkButtonVariants;
  interface HyCtaLink {
    isExternal?: boolean;
    linkContent?: string;
    scLabel?: string;
    url?: string;
    variant?: CtaLinkVariants;
Markus Kaarto's avatar
Markus Kaarto committed
  interface HyDocsContainer {}
Tuukka Turu's avatar
Tuukka Turu committed
  interface HyFooter {}
  interface HyFooterAction {
    /**
     * Up button label.
     */
    upButtonLabel?: string;
    /**
     * String of text for updated text to be displayed.
     */
    updatedText?: string;
  }
  interface HyFooterBase {
    /**
     * Link item color
     */
    color?: FooterLinkItemColor;
    /**
     * Copyright text
     */
    copyrightText?: string;
    /**
     * Footer links to be displayed
     */
    dataFooterBaseLinks?: FooterBaseLinks[] | string;
    /**
     * Footer some links
     */
    dataFooterBaseSome?: FooterBaseSome[] | string;
    /**
     * Logo label
     */
    logoLabel?: string;
    /**
     * Logo url
     */
    logoUrl?: string;
    /**
     * Logo size
     */
    size?: SiteLogoSize;
    /**
     * Label for some links
     */
    someLabel?: string;
  }
  interface HyFooterInfo {
    /**
     * Data for links to be displayed.
     */
    dataFooterInfoLinks?: FooterInfoLinks[] | string;
    /**
     * Content area link button text.
     */
    linkText?: string;
    /**
     * Content area link button url.
     */
    linkUrl?: string;
    /**
     * Content area text.
     */
    textDescription?: string;
    /**
     * Content area title.
     */
    textTitle?: string;
  }
  interface HyFooterLinkItem {
    color?: FooterLinkItemColor;
    isMobile?: boolean;
    items?: Array<any>;
    label?: string;
    mainLink?: boolean;
    url?: string;
  }
Markus Kaarto's avatar
Markus Kaarto committed
  interface HyGridContainer {}
  interface HyGridItem {
    columns?: GridColumns;
    columnslg?: GridColumnsLg;
    columnssm?: GridColumnsSm;
    contentalign?: GridAlignVariants;
  }
  interface HyGridRow {}
  interface HyHeading {
    headerstyle?: string;
Markus Kaarto's avatar
Markus Kaarto committed
    heading?: HeadingVarians;
Markus Kaarto's avatar
Markus Kaarto committed
    negative?: boolean;
Markus Kaarto's avatar
Markus Kaarto committed
    section?: HeadingSectionVariants;
  }
Tuukka Turu's avatar
Tuukka Turu committed
  interface HyHero {
    colorVariant?: HeroColorVariant;
    description?: string;
    headerstyle?: string;
Tuukka Turu's avatar
Tuukka Turu committed
    heading?: string;
    image?: string;
    scLabel?: string;
    url?: string;
    urlTitle?: string;
  }
Markus Kaarto's avatar
Markus Kaarto committed
  interface HyIcon {
    fill?: string;
    icon?: string;
    size?: number;
  }
  interface HyImage {
    aspectRatioHeight?: number;
    aspectRatioWidth?: number;
    caption?: string;
    imageAlt?: string;
    imageUrl?: string;
  }
  interface HyIngress {}
  interface HyIntroduction {
    imageUrl?: string;
    reversed?: boolean;
    scLabel?: string;
    textDescription?: string;
    textTitle?: string;
    url?: string;
    urlTitle?: string;
    variant?: IntroductionBgColors;
  }
  interface HyKeyFigure {
    description?: string;
    heading?: string;
    variant?: KeyHighlightVariants;
  }
  interface HyKeyFigureGroup {
    dataItems?: KeyFigureValue[] | string;
  }
  interface HyKeyHighlight {
    description?: string;
    heading?: string;
    variant?: KeyHighlightVariants;
  }
  interface HyKeyHighlightGroup {
    dataItems?: KeyHighlightValue[] | string;
    variant?: KeyHighlightVariants;
  }
  interface HyLargeProcessFlow {
    dataItems?: ProcessFlowValue[] | string;
  }
  interface HyLargeProcessFlowPhase {
    dataItems?: PhaseValue[] | string;
  }
Markus Kaarto's avatar
Markus Kaarto committed
  interface HyLink {
    isExternal?: boolean;
    linkContent?: string;
Markus Kaarto's avatar
Markus Kaarto committed
    url?: string;
    variant?: LinkVariants;
  }
  interface HyLinkBox {
Ekaterina Kondareva's avatar
Ekaterina Kondareva committed
    headerstyle?: string;
Markus Kaarto's avatar
Markus Kaarto committed
    imageAlt?: string;
    imageUrl?: string;
    isExternal?: boolean;
    textDescription?: string;
    textTitle?: string;
    url?: string;
    variant?: LinkBoxVariants;
  }
  interface HyLinkBoxList {
    dataItems?: LinkBox[] | string;
    variant?: LinkBoxVariants;
  interface HyLinkList {
    dataItems?: CtaLinkValue[] | string;
    listHeading?: string;
  }
Ekaterina Kondareva's avatar
Ekaterina Kondareva committed
  interface HyMain {
    hasSidebar?: boolean;
  }
  interface HyMenu {
    dataMenuDonate?: string;
    dataMenuLanguage?: string;
    logoLabel?: string;
    logoUrl?: string;
    menuButtonBreadcrumbReturn?: string;
    menuIsOpen?: boolean;
    menuType?: MenuType;
    onMenuContainerToggled?: (event: CustomEvent<any>) => void;
  }
  interface HyMenuItem {
    ariaExpanded?: boolean;
    depth?: number;
    hasChildren?: boolean;
    inActiveTrail?: boolean;
    isActive?: boolean;
    isActiveChild?: boolean;
    isHeading?: boolean;
    isParent?: boolean;
    menuItemAlternative?: boolean;
    menuLinkId?: string;
    onAddBreadcrumb?: (event: CustomEvent<any>) => void;
    onMenuContainerActiveTrail?: (event: CustomEvent<any>) => void;
    onMenuContainerToggled?: (event: CustomEvent<any>) => void;
    onRouteClicked?: (event: CustomEvent<any>) => void;
    parentAsHeading?: string;
    parentExpanded?: boolean;
    url?: string;
  }
  interface HyMenuLanguage {
    dataMenuLanguage?: MenuLanguage[] | string;
    isMobile?: boolean;
    labels?: ComponentLabels[] | string;
  }
  interface HyMenuLanguageItem {
    abbr?: string;
    isActive?: boolean;
    isMobile?: boolean;
    label?: string;
    langCode?: string;
    url?: string;
  }
  interface HyMenuLevelContainer {
    activeTrailTriggered?: boolean;
    depth?: number;
    headingItem?: any;
    triggerItem?: string;
  }
  interface HyMenuMobileBreadcrumb {
    bid?: string;
    isFirst?: boolean;
    label?: string;
    labelBack?: string;
    labelFrontPage?: string;
    onRemoveBreadcrumb?: (event: CustomEvent<any>) => void;
  }
  interface HyProcess {
    dataItems?: ProcessFlowBoxValue[] | string;
    numberTerm?: string;
  }
  interface HyProcessFlowBox {
    boxDescription?: string;
    boxNumber?: string;
    boxTitle?: string;
    intermediateStepTitle?: string;
    numberTerm?: string;
    stepState?: ProcessFlowBoxStepStates;
    variant?: ProcessFlowBoxVariants;
  }
  interface HyProminentImage {
    headerstyle?: string;
    imageUrl?: string;
    textTitle?: string;
  }
Ekaterina Kondareva's avatar
Ekaterina Kondareva committed
  interface HyQuote {
    quoteSignature?: string;
  }
Markus Kaarto's avatar
Markus Kaarto committed
  interface HyRow {
    /**
     * justify-content property.
     */
Markus Kaarto's avatar
Markus Kaarto committed
    align?: string;
    /**
     * justify-content property.
     */
Markus Kaarto's avatar
Markus Kaarto committed
    justify?: string;
    /**
     * Left margin to be added to adjacent items.
     */
Markus Kaarto's avatar
Markus Kaarto committed
    margin?: number;
Markus Kaarto's avatar
Markus Kaarto committed
  }
  interface HySectionContainer {}
  interface HyShortcuts {
    dataItems?: ShortcutLinkValue[] | string;
    listHeading?: string;
  }
  interface HySiteHeader {
    dataMenuDonate?: string;
    dataMenuLanguage?: string;
    logoLabel?: string;
    logoUrl?: string;
    menuLabelClose?: string;
    menuLabelOpen?: string;
  }
  interface HySiteLogo {
    label?: string;
    url?: string;
  }
  interface HySiteSearch {
Markus Kalijärvi's avatar
Markus Kalijärvi committed
    labels?: ComponentLabels[] | string;
Tuukka Turu's avatar
Tuukka Turu committed
  interface HyTabs {
    headerstyle?: string;
Tuukka Turu's avatar
Tuukka Turu committed
    tabId?: string;
    tabListLabel?: string;
  }
  interface HyTabsItem {
    tabTitle?: string;
  }
Markus Kaarto's avatar
Markus Kaarto committed
  interface HyTinyText {}
  interface HyTwoColumns {
    reversed?: boolean;
  }
  interface HyUserLoginForm {
    logoLabel?: string;
    logoUrl?: string;
  }
Markus Kaarto's avatar
Markus Kaarto committed
  interface IntrinsicElements {
    'color-box': ColorBox;
    'hy-accordion-container': HyAccordionContainer;
    'hy-accordion-item': HyAccordionItem;
    'hy-adjacent-image-text': HyAdjacentImageText;
    'hy-badge': HyBadge;
    'hy-banner': HyBanner;
    'hy-baseline': HyBaseline;
    'hy-box': HyBox;
    'hy-box-container': HyBoxContainer;
Tuukka Turu's avatar
Tuukka Turu committed
    'hy-breadcrumbs': HyBreadcrumbs;
    'hy-button': HyButton;
    'hy-cta-button': HyCtaButton;
    'hy-cta-link': HyCtaLink;
    'hy-docs-container': HyDocsContainer;
Tuukka Turu's avatar
Tuukka Turu committed
    'hy-footer': HyFooter;
    'hy-footer-action': HyFooterAction;
    'hy-footer-base': HyFooterBase;
    'hy-footer-info': HyFooterInfo;
    'hy-footer-link-item': HyFooterLinkItem;
    'hy-grid-container': HyGridContainer;
    'hy-grid-item': HyGridItem;
    'hy-grid-row': HyGridRow;
    'hy-heading': HyHeading;
Tuukka Turu's avatar
Tuukka Turu committed
    'hy-hero': HyHero;
    'hy-icon': HyIcon;
    'hy-image': HyImage;
    'hy-ingress': HyIngress;
    'hy-introduction': HyIntroduction;
    'hy-key-figure': HyKeyFigure;
    'hy-key-figure-group': HyKeyFigureGroup;
    'hy-key-highlight': HyKeyHighlight;
    'hy-key-highlight-group': HyKeyHighlightGroup;
    'hy-large-process-flow': HyLargeProcessFlow;
    'hy-large-process-flow-phase': HyLargeProcessFlowPhase;
    'hy-link': HyLink;
    'hy-link-box': HyLinkBox;
    'hy-link-box-list': HyLinkBoxList;
    'hy-link-list': HyLinkList;
Ekaterina Kondareva's avatar
Ekaterina Kondareva committed
    'hy-main': HyMain;
    'hy-main-content-wrapper': HyMainContentWrapper;
    'hy-menu': HyMenu;
    'hy-menu-item': HyMenuItem;
    'hy-menu-language': HyMenuLanguage;
    'hy-menu-language-item': HyMenuLanguageItem;
    'hy-menu-level-container': HyMenuLevelContainer;
    'hy-menu-mobile-breadcrumb': HyMenuMobileBreadcrumb;
    'hy-paragraph-text': HyParagraphText;
    'hy-process': HyProcess;
    'hy-process-flow-box': HyProcessFlowBox;
    'hy-prominent-image': HyProminentImage;
Ekaterina Kondareva's avatar
Ekaterina Kondareva committed
    'hy-quote': HyQuote;
    'hy-row': HyRow;
    'hy-section-container': HySectionContainer;
    'hy-shortcuts': HyShortcuts;
    'hy-site-header': HySiteHeader;
    'hy-site-logo': HySiteLogo;
    'hy-site-search': HySiteSearch;
Tuukka Turu's avatar
Tuukka Turu committed
    'hy-tabs': HyTabs;
    'hy-tabs-item': HyTabsItem;
    'hy-tiny-text': HyTinyText;
    'hy-two-columns': HyTwoColumns;
    'hy-user-login-form': HyUserLoginForm;
export {LocalJSX as JSX};
declare module '@stencil/core' {
Markus Kaarto's avatar
Markus Kaarto committed
  export namespace JSX {
    interface IntrinsicElements {
      'color-box': LocalJSX.ColorBox & JSXBase.HTMLAttributes<HTMLColorBoxElement>;
      'hy-accordion-container': LocalJSX.HyAccordionContainer & JSXBase.HTMLAttributes<HTMLHyAccordionContainerElement>;
      'hy-accordion-item': LocalJSX.HyAccordionItem & JSXBase.HTMLAttributes<HTMLHyAccordionItemElement>;
      'hy-adjacent-image-text': LocalJSX.HyAdjacentImageText & JSXBase.HTMLAttributes<HTMLHyAdjacentImageTextElement>;
      'hy-badge': LocalJSX.HyBadge & JSXBase.HTMLAttributes<HTMLHyBadgeElement>;
      'hy-banner': LocalJSX.HyBanner & JSXBase.HTMLAttributes<HTMLHyBannerElement>;
      'hy-baseline': LocalJSX.HyBaseline & JSXBase.HTMLAttributes<HTMLHyBaselineElement>;
      'hy-box': LocalJSX.HyBox & JSXBase.HTMLAttributes<HTMLHyBoxElement>;
      'hy-box-container': LocalJSX.HyBoxContainer & JSXBase.HTMLAttributes<HTMLHyBoxContainerElement>;
Tuukka Turu's avatar
Tuukka Turu committed
      'hy-breadcrumbs': LocalJSX.HyBreadcrumbs & JSXBase.HTMLAttributes<HTMLHyBreadcrumbsElement>;
      'hy-button': LocalJSX.HyButton & JSXBase.HTMLAttributes<HTMLHyButtonElement>;
      'hy-cta-button': LocalJSX.HyCtaButton & JSXBase.HTMLAttributes<HTMLHyCtaButtonElement>;
      'hy-cta-link': LocalJSX.HyCtaLink & JSXBase.HTMLAttributes<HTMLHyCtaLinkElement>;
      'hy-docs-container': LocalJSX.HyDocsContainer & JSXBase.HTMLAttributes<HTMLHyDocsContainerElement>;
Tuukka Turu's avatar
Tuukka Turu committed
      'hy-footer': LocalJSX.HyFooter & JSXBase.HTMLAttributes<HTMLHyFooterElement>;
      'hy-footer-action': LocalJSX.HyFooterAction & JSXBase.HTMLAttributes<HTMLHyFooterActionElement>;
      'hy-footer-base': LocalJSX.HyFooterBase & JSXBase.HTMLAttributes<HTMLHyFooterBaseElement>;
      'hy-footer-info': LocalJSX.HyFooterInfo & JSXBase.HTMLAttributes<HTMLHyFooterInfoElement>;
      'hy-footer-link-item': LocalJSX.HyFooterLinkItem & JSXBase.HTMLAttributes<HTMLHyFooterLinkItemElement>;
      'hy-grid-container': LocalJSX.HyGridContainer & JSXBase.HTMLAttributes<HTMLHyGridContainerElement>;
      'hy-grid-item': LocalJSX.HyGridItem & JSXBase.HTMLAttributes<HTMLHyGridItemElement>;
      'hy-grid-row': LocalJSX.HyGridRow & JSXBase.HTMLAttributes<HTMLHyGridRowElement>;
      'hy-heading': LocalJSX.HyHeading & JSXBase.HTMLAttributes<HTMLHyHeadingElement>;
Tuukka Turu's avatar
Tuukka Turu committed
      'hy-hero': LocalJSX.HyHero & JSXBase.HTMLAttributes<HTMLHyHeroElement>;
      'hy-icon': LocalJSX.HyIcon & JSXBase.HTMLAttributes<HTMLHyIconElement>;
      'hy-image': LocalJSX.HyImage & JSXBase.HTMLAttributes<HTMLHyImageElement>;
      'hy-ingress': LocalJSX.HyIngress & JSXBase.HTMLAttributes<HTMLHyIngressElement>;
      'hy-introduction': LocalJSX.HyIntroduction & JSXBase.HTMLAttributes<HTMLHyIntroductionElement>;
      'hy-key-figure': LocalJSX.HyKeyFigure & JSXBase.HTMLAttributes<HTMLHyKeyFigureElement>;
      'hy-key-figure-group': LocalJSX.HyKeyFigureGroup & JSXBase.HTMLAttributes<HTMLHyKeyFigureGroupElement>;
      'hy-key-highlight': LocalJSX.HyKeyHighlight & JSXBase.HTMLAttributes<HTMLHyKeyHighlightElement>;
      'hy-key-highlight-group': LocalJSX.HyKeyHighlightGroup & JSXBase.HTMLAttributes<HTMLHyKeyHighlightGroupElement>;
      'hy-large-process-flow': LocalJSX.HyLargeProcessFlow & JSXBase.HTMLAttributes<HTMLHyLargeProcessFlowElement>;
      'hy-large-process-flow-phase': LocalJSX.HyLargeProcessFlowPhase &
        JSXBase.HTMLAttributes<HTMLHyLargeProcessFlowPhaseElement>;
      'hy-link': LocalJSX.HyLink & JSXBase.HTMLAttributes<HTMLHyLinkElement>;
      'hy-link-box': LocalJSX.HyLinkBox & JSXBase.HTMLAttributes<HTMLHyLinkBoxElement>;
      'hy-link-box-list': LocalJSX.HyLinkBoxList & JSXBase.HTMLAttributes<HTMLHyLinkBoxListElement>;
      'hy-link-list': LocalJSX.HyLinkList & JSXBase.HTMLAttributes<HTMLHyLinkListElement>;
Ekaterina Kondareva's avatar
Ekaterina Kondareva committed
      'hy-main': LocalJSX.HyMain & JSXBase.HTMLAttributes<HTMLHyMainElement>;
      'hy-main-content-wrapper': LocalJSX.HyMainContentWrapper &
        JSXBase.HTMLAttributes<HTMLHyMainContentWrapperElement>;
      'hy-menu': LocalJSX.HyMenu & JSXBase.HTMLAttributes<HTMLHyMenuElement>;
      'hy-menu-item': LocalJSX.HyMenuItem & JSXBase.HTMLAttributes<HTMLHyMenuItemElement>;
      'hy-menu-language': LocalJSX.HyMenuLanguage & JSXBase.HTMLAttributes<HTMLHyMenuLanguageElement>;
      'hy-menu-language-item': LocalJSX.HyMenuLanguageItem & JSXBase.HTMLAttributes<HTMLHyMenuLanguageItemElement>;
      'hy-menu-level-container': LocalJSX.HyMenuLevelContainer &
        JSXBase.HTMLAttributes<HTMLHyMenuLevelContainerElement>;
      'hy-menu-mobile-breadcrumb': LocalJSX.HyMenuMobileBreadcrumb &
        JSXBase.HTMLAttributes<HTMLHyMenuMobileBreadcrumbElement>;
      'hy-paragraph-text': LocalJSX.HyParagraphText & JSXBase.HTMLAttributes<HTMLHyParagraphTextElement>;
      'hy-process': LocalJSX.HyProcess & JSXBase.HTMLAttributes<HTMLHyProcessElement>;
      'hy-process-flow-box': LocalJSX.HyProcessFlowBox & JSXBase.HTMLAttributes<HTMLHyProcessFlowBoxElement>;
      'hy-prominent-image': LocalJSX.HyProminentImage & JSXBase.HTMLAttributes<HTMLHyProminentImageElement>;
Ekaterina Kondareva's avatar
Ekaterina Kondareva committed
      'hy-quote': LocalJSX.HyQuote & JSXBase.HTMLAttributes<HTMLHyQuoteElement>;
      'hy-row': LocalJSX.HyRow & JSXBase.HTMLAttributes<HTMLHyRowElement>;
      'hy-section-container': LocalJSX.HySectionContainer & JSXBase.HTMLAttributes<HTMLHySectionContainerElement>;
      'hy-shortcuts': LocalJSX.HyShortcuts & JSXBase.HTMLAttributes<HTMLHyShortcutsElement>;
      'hy-site-header': LocalJSX.HySiteHeader & JSXBase.HTMLAttributes<HTMLHySiteHeaderElement>;
      'hy-site-logo': LocalJSX.HySiteLogo & JSXBase.HTMLAttributes<HTMLHySiteLogoElement>;
      'hy-site-search': LocalJSX.HySiteSearch & JSXBase.HTMLAttributes<HTMLHySiteSearchElement>;
Tuukka Turu's avatar
Tuukka Turu committed
      'hy-tabs': LocalJSX.HyTabs & JSXBase.HTMLAttributes<HTMLHyTabsElement>;
      'hy-tabs-item': LocalJSX.HyTabsItem & JSXBase.HTMLAttributes<HTMLHyTabsItemElement>;
      'hy-tiny-text': LocalJSX.HyTinyText & JSXBase.HTMLAttributes<HTMLHyTinyTextElement>;
      'hy-two-columns': LocalJSX.HyTwoColumns & JSXBase.HTMLAttributes<HTMLHyTwoColumnsElement>;
      'hy-user-login-form': LocalJSX.HyUserLoginForm & JSXBase.HTMLAttributes<HTMLHyUserLoginFormElement>;