The igc-carousel presents a set of igc-carousel-slides by sequentially displaying a subset of one or more slides.

Type Parameters

Hierarchy

Hierarchy

  • Component<P & Omit<React.HTMLAttributes<HTMLElement>, keyof P>, {}>
    • IgrCarousel

Constructors

  • Type parameters

    Type Parameters

    Parameters

    • props: P & Omit<HTMLAttributes<HTMLElement>, keyof P>

    Returns IgrCarousel<P>

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get current(): number
  • The index of the current active slide.

    Returns number

  • get disableLoop(): boolean
  • Whether the carousel should skip rotating to the first slide after it reaches the last.

    Returns boolean

  • set disableLoop(v): void
  • Parameters

    • v: boolean

    Returns void

  • get disablePauseOnInteraction(): boolean
  • Whether the carousel should ignore use interactions and not pause on them.

    Returns boolean

  • set disablePauseOnInteraction(v): void
  • Parameters

    • v: boolean

    Returns void

  • get hideIndicators(): boolean
  • Whether the carousel should render the indicator controls (dots).

    Returns boolean

  • set hideIndicators(v): void
  • Parameters

    • v: boolean

    Returns void

  • get hideNavigation(): boolean
  • Whether the carousel should skip rendering of the default navigation buttons.

    Returns boolean

  • set hideNavigation(v): void
  • Parameters

    • v: boolean

    Returns void

  • get indicatorsLabelFormat(): string
  • The format used to set the aria-label on the carousel indicators. Instances of '{0}' will be replaced with the index of the corresponding slide.

    Returns string

  • set indicatorsLabelFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get interval(): number
  • The duration in milliseconds between changing the active slide.

    Returns number

  • set interval(v): void
  • Parameters

    • v: number

    Returns void

  • get isPaused(): boolean
  • Whether the carousel in in paused state.

    Returns boolean

  • get isPlaying(): boolean
  • Whether the carousel is in playing state.

    Returns boolean

  • get maximumIndicatorsCount(): number
  • Controls the maximum indicator controls (dots) that can be shown. Default value is 10.

    Returns number

  • set maximumIndicatorsCount(v): void
  • Parameters

    • v: number

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get slidesLabelFormat(): string
  • The format used to set the aria-label on the carousel slides and the text displayed when the number of indicators is greater than tha maximum indicator count. Instances of '{0}' will be replaced with the index of the corresponding slide. Instances of '{1}' will be replaced with the total amount of slides.

    Returns string

  • set slidesLabelFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get total(): number
  • The total number of slides.

    Returns number

  • get vertical(): boolean
  • Whether the carousel has vertical alignment.

    Returns boolean

  • set vertical(v): void
  • Parameters

    • v: boolean

    Returns void

Methods

  • Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

    Calling Component#setState generally does not trigger this method.

    This method will not stop working in React 17.

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

    Parameters

    • nextProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • nextContext: any

    Returns void

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    • prevProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • prevState: Readonly<{}>

    Returns any

  • Switches to the next slide, runs any animations, and returns if the operation was successful.

    Returns boolean

  • Pauses the carousel rotation of slides.

    Returns void

  • Resumes playing of the carousel slides.

    Returns void

  • Switches to the previous slide, runs any animations, and returns if the operation was successful.

    Returns boolean

  • Returns DOMElement<{
        children: any[];
        class: (P & Omit<HTMLAttributes<HTMLElement>, keyof P>)["className"];
        id: (P & Omit<HTMLAttributes<HTMLElement>, keyof P>)["id"];
        ref: ((ref) => void);
        style: {};
    }, any>

  • Parameters

    Returns boolean

  • Parameters

    • element: any

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean