Components.NavbarContent public
Component to wrap the collapsible content of a Components.Navbar component. Have a look there for examples.
Item Index
Methods
Properties
- active
- autoPlay
- canTurnToLeft
- canTurnToRight
- childSlides
- childSlidesObserver
- collapsed
- collapseDimension
- collapsedSize
- currentIndex
- currentSlide
- directionalClassName
- expandedSize
- followingIndex
- hasInterval
- index
- indexObserver
- indicators
- interval
- isMouseHovering
- keyboard
- ltr
- nextControlClassName
- nextControlIcon
- nextControlLabel
- orderClassName
- pauseOnMouseEnter
- presentationState
- prevControlClassName
- prevControlIcon
- prevControlLabel
- resetSizeWhenNotCollapsing
- shouldNotDoPresentation
- shouldRunAutomatically
- showControls
- showIndicators
- slideComponent
- transition
- transitionDuration
- transitioning
- wrap
Events
assignClassNameControls
private
Indicates what class names should be applicable to the current transition slides.
cycle
private
Do a presentation and calls itself to perform a cycle.
getExpandedSize Number
private
Get the size of the element when expanded
Parameters:
-
actionObject
Returns:
Number:
hide
protected
Triggers the hide transition
setFollowingIndex
private
Sets the following slide index within the lower and upper bounds.
show
protected
Triggers the show transition
toAppropriateSlide
private
Coordinates the correct slide movement direction.
transitioner
privatetriggerChildSlidesObserver
privatewaitIntervalToInitCycle
private
Waits an interval time to start a cycle.
active unknown private
True if this item is expanded
autoPlay boolean public
Starts automatic sliding on page load.
This parameter has no effect if interval is less than or equal to zero.
canTurnToLeft unknown private
If a slide can turn to left, including corners.
canTurnToRight unknown private
If a slide can turn to right, including corners.
childSlides array private
All
CarouselSlide child components.
childSlidesObserver unknown private
This observer is the entry point for real time insertion and removing of slides.
collapsed boolean public
Collapsed/expanded state
collapseDimension string public
The direction (height/width) of the collapse animation.
When setting this to 'width' you should also define custom CSS transitions for the width property, as the Bootstrap
CSS does only support collapsible elements for the height direction.
collapsedSize number public
The size of the element when collapsed. Defaults to 0.
currentIndex unknown private
Indicates the current index of the current slide.
currentSlide unknown private
The current slide object that is going to be used by the nested slides components.
directionalClassName string private
Bootstrap style to indicate that a given slide should be moving to left/right.
expandedSize number public
The size of the element when expanded. When null the value is calculated automatically to fit the containing elements.
followingIndex number private
Indicates the next slide index to move into.
hasInterval boolean private
index number public
Index of starting slide.
indexObserver unknown private
This observer is the entry point for programmatically slide changing.
indicators unknown private
interval number public
Waiting time before automatically show another slide.
Automatic sliding is canceled if interval is less than or equal to zero.
isMouseHovering boolean private
If user is hovering its cursor on component.
This property is only manipulated when 'pauseOnMouseEnter' is true.
keyboard boolean public
Should bind keyboard events into sliding.
ltr boolean public
If automatic sliding should be left-to-right or right-to-left.
This parameter has no effect if interval is less than or equal to zero.
nextControlClassName string private
The class name to append to the next control link element.
nextControlIcon string public
The next control icon to be displayed.
nextControlLabel string public
Label for screen readers, defaults to 'Next'.
orderClassName string private
Bootstrap style to indicate the next/previous slide.
pauseOnMouseEnter boolean public
Pauses automatic sliding if mouse cursor is hovering the component.
This parameter has no effect if interval is less than or equal to zero.
presentationState string private
The current state of the current presentation, can be either "didTransition"
or "willTransit".
prevControlClassName string private
The class name to append to the previous control link element.
prevControlIcon string public
The previous control icon to be displayed.
prevControlLabel string public
Label for screen readers, defaults to 'Previous'.
resetSizeWhenNotCollapsing boolean private
Usually the size (height) of the element is only set while transitioning, and reseted afterwards. Set to true to always set a size.
shouldNotDoPresentation boolean private
shouldRunAutomatically boolean private
showControls boolean public
Show or hide controls.
showIndicators boolean public
Show or hide indicators.
slideComponent {String} private
transition string public
The type slide transition to perform.
Options are 'fade' or 'slide'. Note: BS4 only
transitionDuration number public
The duration of the slide transition.
You should also change this parameter in Bootstrap CSS file.
transitioning boolean private
true if the component is currently transitioning
wrap boolean public
If false will hard stop on corners, i.e., first slide won't make a transition to the
last slide and vice versa.
onHidden
public
The action to be sent after the element has been completely hidden (including the CSS transition).
onHide
public
The action to be sent when the element is about to be hidden.
onShow
public
The action to be sent when the element is about to be shown.
onShown
public
The action to be sent after the element has been completely shown (including the CSS transition).
onSlideChanged
public
Action called after the slide has changed.
Event Payload:
-
toIndexObject