1.1.10 • Published 1 month ago

@synerise/ds-banner v1.1.10

Weekly downloads
-
License
ISC
Repository
github
Last release
1 month ago

id: banner

title: Banner

Banner UI Component

Installation

npm i @synerise/ds-banner
or
yarn add @synerise/ds-banner

Usage

import Banner from '@synerise/ds-banner'

<Banner />

Demo

API

PropertyDescriptionTypeDefault
slidesArray of slides to displayBannerSlideProps[]-
autoPlayauto-start slideshow (if multiple slides present)booleantrue
transitionEffectslide transition effect'scrollx' / 'fade' see antd carousel'scrollx'
autoPlaySpeedduration of single slide display (ms)number5000
onAfterChangehandler to call after slides change(index: number) => void-
onBeforeChangehandler to call before slides change(from: number, to: index) => void-
onClosehandler to call when 'X' is clicked() => void-
expandabledisplays persistent bar above slides with a collapse button and titleExpandableProps-
textscustom translationsBannerTexts-

BannerSlideProps

PropertyDescriptionTypeDefault
mainContentmain area contentBannerSlideTextContentProps / BannerSlideMediaContentProps-
leftSideContentleft side contentBannerSlideTextContentProps / BannerSlideMediaContentProps-
rightSideContentright side contentBannerSlideTextContentProps / BannerSlideMediaContentProps-

BannerSlideTextContentProps

PropertyDescriptionTypeDefault
titlePrefixicon / avatar prefix of the titleReactNode-
titleStatusTitle status tagStatusProps, see ds-status-
titleSlide titleReactNode-
buttonsSlide buttonsReactNode-
descriptionSlide description textReactNode-

BannerSlideMediaContentProps

PropertyDescriptionTypeDefault
mediaimage to displayReactNode-

ExpandableProps

PropertyDescriptionTypeDefault
titleTop bar title textReactNode-
iconTop bar icon prefixReactNode-
expandeddefault exapnded statebooleantrue

BannerTexts

PropertyDescriptionTypeDefault
expandtoggle button label when banner is collapsedReactNode'Expand'
collapsetoggle button label when banner is expandedReactNode'Collapse'
closeTooltiptooltip text over 'X' iconReactNode'Close'
1.1.1

4 months ago

1.1.0

4 months ago

1.0.0

4 months ago

1.1.9

1 month ago

1.1.8

2 months ago

1.1.7

2 months ago

1.1.6

2 months ago

1.1.5

3 months ago

1.1.4

3 months ago

1.1.3

3 months ago

1.1.2

4 months ago

1.1.10

1 month ago

0.2.9

4 months ago

0.2.8

4 months ago

0.2.7

5 months ago

0.2.6

5 months ago

0.2.5

5 months ago

0.2.4

5 months ago

0.2.3

5 months ago

0.2.2

5 months ago

0.2.1

5 months ago

0.2.0

6 months ago

0.1.4

6 months ago

0.1.3

6 months ago

0.1.2

7 months ago

0.1.1

7 months ago

0.1.0

7 months ago

0.0.1

8 months ago