Skip to content

Latest commit

 

History

History
515 lines (418 loc) · 15.4 KB

README.props.md

File metadata and controls

515 lines (418 loc) · 15.4 KB

Components

CardCarouselNews(props)
CardGridNews(props)
CardListlNews(props)

Typedefs

ArticleProps : Object
CardProps : Object
FeedHeader : Object
FeedCtaButton : Object
FeedCardButton : Object
DataSource : Object
FeedType : Object
HeroProps : Object
ImageComponentProps : Object
ButtonProps : Object
ButtonIconOnlyProps : Object
TagsProps : Object
BreadcrumbProps : Object
ImageProps : Object
ContentProps : Object
AccordionCard : Object
AccordionProps : Object
ReactMouseEventvoid
AccordionCardItemProps : Object
AnchorMenuItem : Object
AnchorMenuProps : Object
PageChangeEventvoid
PaginationProps : Object
PageItemProps : Object
TestimonialStyle : Object
TestimonialQuote : Object
TestimonialProps : Object
VideoProps : Object

CardCarouselNews(props)

Kind: global function

Param Type
props FeedType

CardGridNews(props)

Kind: global function

Param Type
props FeedType

CardListlNews(props)

Kind: global function

Param Type
props FeedType

ArticleProps : Object

Kind: global typedef
Properties

Name Type
type "event" | "news"
[articleUrl] string
[publicationDate] string
[title] string
[body] string
[authorEmail] string
[authorName] string
[authorPhone] string
[authorTitle] string
[breadcrumbs] Array.<BreadcrumbProps>
[calendarUrl] string
[eventLocation] string
[eventTime] string
[headerImageUrl] string
[registrationUrl] string
[zoomUrl] string

CardProps : Object

Kind: global typedef
Properties

Name Type
[type] string
[horizontal] boolean
[image] string
[imageAltText] string
title string
[icon] Array.<string>
[body] string
[eventLocation] string
[eventTime] string
[linkLabel] string
[linkUrl] string
[buttons] Array.<ButtonProps>
[eventFormat] "stack" | "inline"
[width] "25%" | "50%" | "75%" | "100%"
[tags] Array.<TagsProps>
[showBorders] boolean
[cardLink] string

FeedHeader : Object

Kind: global typedef
Properties

Name Type
[color] "white" | "dark"
[text] string

FeedCtaButton : Object

Kind: global typedef
Properties

Name Type
[color] "gold" | "maroon" | "gray" | "dark"
[text] string
[url] string

FeedCardButton : Object

Kind: global typedef
Properties

Name Type
[color] "gold" | "maroon" | "gray" | "dark"
[text] string
[size] "default" | "small" | "medium" | "large"

DataSource : Object

Kind: global typedef
Properties

Name Type
[url] string
[filters] string

FeedType : Object

Kind: global typedef
Properties

Name Type
[header] FeedHeader
[ctaButton] FeedCtaButton
[cardButton] FeedCardButton
[dataSource] DataSource
[maxItems] number

HeroProps : Object

Kind: global typedef
Properties

Name Type Description
[hide] boolean
[image] ImageProps
[title] ContentProps
[subTitle] ContentProps
[contents] Array.<ContentProps>
[contentsColor] "white" | "black"
[type] "heading-hero" | "story-hero" defaut value is "heading-hero"

ImageComponentProps : Object

Kind: global typedef
Properties

Name Type
src string
alt string
[cssClasses] Array.<string>
[loading] "lazy" | "eager"
[decoding] "sync" | "async" | "auto"
[fetchPriority] "auto" | "high" | "low"
[width] string
[height] string
[dataTestId] string
[cardLink] string
[title] string

ButtonProps : Object

Kind: global typedef
Properties

Name Type
[label] string
[cardTitle] string
[ariaLabel] string
[block] boolean
[disabled] boolean
[element] any
[href] string
[icon] Array.<string>
[innerRef] any
[classes] Array.<string>
[onClick] function
[size] "default" | "small" | "xsmall"
[color] "gold" | "maroon" | "gray" | "dark"
[target] "_blank" | "_self" | "_top" | "_parent"

ButtonIconOnlyProps : Object

Kind: global typedef
Properties

Name Type
icon Array.<string>
[color] string
[innerRef] React.RefObject
[onClick] function
[size] "large" | "small"
[cardTitle] string

TagsProps : Object

Kind: global typedef
Properties

Name Type
[label] string
[cardTitle] string
[ariaLabel] string
[color] string
[disabled] boolean
[href] string
[onClick] function
[element] JSX.Element | string
[innerRef] React.RefObject

BreadcrumbProps : Object

Kind: global typedef
Properties

Name Type
title string
url string
active boolean

ImageProps : Object

Kind: global typedef
Properties

Name Type
url string
[altText] string
[cssClass] Array.<string>
[size] "small" | "medium" | "large"

ContentProps : Object

Kind: global typedef
Properties

Name Type
text string
[maxWidth] string
[cssClass] Array.<string>
[color] "black" | "white"
[highlightColor] "gold" | "black" | "white"

AccordionCard : Object

Kind: global typedef
Properties

Name Type
[color] "gold" | "maroon" | "gray" | "dark"
[content] Object
[content.icon] string
content.header string
content.body string

AccordionProps : Object

Kind: global typedef
Properties

Name Type
cards Array.<AccordionCard>
[openedCard] number

ReactMouseEvent ⇒ void

Kind: global typedef

Param Type
event React.MouseEvent.<HTMLAnchorElement, MouseEvent>
id number
[cardTitle] string

AccordionCardItemProps : Object

Kind: global typedef
Properties

Name Type
id number
item AccordionCard
openCard number
onClick ReactMouseEvent

AnchorMenuItem : Object

Kind: global typedef
Properties

Name Type
text string
targetIdName string
[icon] Array.<string>

AnchorMenuProps : Object

Kind: global typedef
Properties

Name Type
items Array.<AnchorMenuItem>
firstElementId string
[focusFirstFocusableElement] boolean

PageChangeEvent ⇒ void

Kind: global typedef

Param Type
e Event
pages number

PaginationProps : Object

Kind: global typedef
Properties

Name Type
type string
background string
[currentPage] number
[totalPages] number
[showFirstButton] boolean
[showLastButton] boolean
[totalNumbers] number
onChange PageChangeEvent

PageItemProps : Object

Kind: global typedef
Properties

Name Type
[isClickeable] boolean
[disabled] boolean
[pageLinkIcon] boolean
[selectedPage] boolean
[ellipses] boolean
[dataId] string
[onClick] function
children React.ReactNode
[ariaLabel] string
[ariaDisabled] boolean

TestimonialStyle : Object

Kind: global typedef
Properties

Name Type
[containerCssClass] Array.<string>
[titleCssClass] Array.<string>
[contentCssClass] Array.<string>

TestimonialQuote : Object

Kind: global typedef
Properties

Name Type
content string
[title] string
cite Object
cite.name string
[cite.description] string

TestimonialProps : Object

Kind: global typedef
Properties

Name Type
imageSource string
imageAltText string
quote TestimonialQuote
itemStyle TestimonialStyle

VideoProps : Object

Kind: global typedef
Properties

Name Type
[type] "youtube" | "video"
url string
[vttUrl] string
[title] string
[caption] string
[className] string
[controls] boolean