Class SplideConfig

Represents the configurations for a provider. Will have a method to get the configurations in the provider format.

Export

Abstract

Hierarchy-Diagram

Legend

class

abstract class

public property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractCarouselConfig
- SplideConfig

Properties

ExtendedClass

ExtendedClass: string

AutoPlay

AutoPlay: boolean

Direction

Direction: LTR | RTL | TTB

Height

Height: string | number

ItemsDesktop

ItemsDesktop: number

ItemsGap

ItemsGap: string | number

ItemsPhone

ItemsPhone: number

ItemsTablet

ItemsTablet: number

Loop

Loop: boolean

Navigation

Navigation: Navigation

Padding

Padding: string | number

StartingPosition

StartingPosition: number

`Private` _providerExtendedOptions

_providerExtendedOptions: Options

`Private` _providerOptions

_providerOptions: Options

Methods

`Protected` validateBoolean

validateBoolean(value: boolean, defaultValue: boolean): boolean
Protected
Method that helps to validate if a boolean is not undefined

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: boolean
- defaultValue: boolean
Returns boolean
Inherited from AbstractCarouselConfig.validateBoolean
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:31

`Protected` validateDate

validateDate(value: string | Date, defaultValue: string): string | Date
Protected
Method that helps to validate if a given value is a valid date

Returns
{(string | Date)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: string | Date
- defaultValue: string
Returns string | Date
Inherited from AbstractCarouselConfig.validateDate
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:44

`Protected` validateInRange

validateInRange(value: unknown, defaultValue: unknown, ...args: unknown[]): unknown
Protected
Method that helps to validate if a given value is within a range of values.

Returns
{unknown}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: unknown
- defaultValue: unknown
- Rest ...args: unknown[]
Returns unknown
Inherited from AbstractCarouselConfig.validateInRange
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:58

`Protected` validateNumber

validateNumber(value: number, defaultValue: number): number
Protected
Method that helps to validate if a number is not empty or undefined.

Returns
{number}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: number
- defaultValue: number
Returns number
Inherited from AbstractCarouselConfig.validateNumber
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:80

`Protected` validateString

validateString(value: string, defaultValue: string): string
Protected
Method that helps to validate if a string is not empty or undefined.

Returns
{string}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: string
- defaultValue: string
Returns string
Inherited from AbstractCarouselConfig.validateString
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:93

`Protected` validateTime

validateTime(value: string, defaultValue: string): string
Protected
Method that helps to validate if a given value is a valid time

Returns
{(string)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: string
- defaultValue: string
Returns string
Inherited from AbstractCarouselConfig.validateTime
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:106

`Protected` mergeConfigs

mergeConfigs(commonConfigs: any, specificConfigs: any, extendedConfigs?: any): any
Protected
Method to merge Common, Specific and External configs

Returns
{ProviderConfigs}

Memberof
OSFramework.Patterns.AbstractProviderConfiguration
Parameters
- commonConfigs: any
- specificConfigs: any
- Optional extendedConfigs: any
Returns any
Inherited from AbstractCarouselConfig.mergeConfigs
- Defined in OSFramework/OSUI/Pattern/AbstractProviderConfiguration.ts:23

validateCanChange

validateCanChange(isBuilt: boolean, key: string): boolean
Method that will check if a given property (key) can be changed/updated!

Returns
boolean

Memberof
OSFramework.Patterns.Carousel.AbstractCarouselConfig
Parameters
- isBuilt: boolean
  
  True when pattern has been built!
- key: string
  
  property name
Returns boolean
Inherited from AbstractCarouselConfig.validateCanChange
- Defined in OSFramework/OSUI/Pattern/Carousel/AbstractCarouselConfig.ts:28

validateDefault

validateDefault(key: string, value: unknown): unknown
Method that will check if a given property (key) value is the type expected!

Returns
value

Memberof
OSFramework.Patterns.Carousel.AbstractCarouselConfig
Parameters
- key: string
  
  property name
- value: unknown
  
  value to be check
Returns unknown
Inherited from AbstractCarouselConfig.validateDefault
- Defined in OSFramework/OSUI/Pattern/Carousel/AbstractCarouselConfig.ts:43

`Private` _getArrowConfig

_getArrowConfig(): boolean
Returns boolean
- Defined in Providers/OSUI/Carousel/Splide/SplideConfig.ts:10

`Private` _getDirectionConfig

_getDirectionConfig(): LTR | RTL | TTB
Returns LTR | RTL | TTB
- Defined in Providers/OSUI/Carousel/Splide/SplideConfig.ts:31

`Private` _getPaginationConfig

_getPaginationConfig(): boolean
Returns boolean
- Defined in Providers/OSUI/Carousel/Splide/SplideConfig.ts:49

getProviderConfig

getProviderConfig(): Options
Method to get and merge internal and external provider configs

Returns
{SplideOpts}

Memberof
Providers.OSUI.Carousel.Splide.SplideConfig

Returns Options
Overrides AbstractCarouselConfig.getProviderConfig
- Defined in Providers/OSUI/Carousel/Splide/SplideConfig.ts:75

setExtensibilityConfigs

setExtensibilityConfigs(newConfigs: Options): void
Method to set and save the extensibility provider configs

Memberof
Providers.OSUI.Carousel.Splide.SplideConfig
Parameters
- newConfigs: Options
Returns void
- Defined in Providers/OSUI/Carousel/Splide/SplideConfig.ts:110

Constructors

constructor

new SplideConfig(config: JSON): SplideConfig
Parameters
- config: JSON
Returns SplideConfig
Inherited from AbstractCarouselConfig.constructor
- Defined in OSFramework/OSUI/Pattern/Carousel/AbstractCarouselConfig.ts:16

Class SplideConfig

Export

Abstract

Hierarchy-Diagram

Legend

Hierarchy

Index

Properties

Methods

Constructors

Properties

ExtendedClass

AutoPlay

Direction

Height

ItemsDesktop

ItemsGap

ItemsPhone

ItemsTablet

Loop

Navigation

Padding

StartingPosition

Private _providerExtendedOptions

Private _providerOptions

Methods

Protected validateBoolean

Returns

Memberof

Parameters

value: boolean

defaultValue: boolean

Returns boolean

Protected validateDate

Returns

Memberof

Parameters

value: string | Date

defaultValue: string

Returns string | Date

Protected validateInRange

Returns

Memberof

Parameters

value: unknown

defaultValue: unknown

Rest ...args: unknown[]

Returns unknown

Protected validateNumber

Returns

Memberof

Parameters

value: number

defaultValue: number

Returns number

Protected validateString

Returns

Memberof

Parameters

value: string

defaultValue: string

Returns string

Protected validateTime

Returns

Memberof

Parameters

value: string

defaultValue: string

Returns string

Protected mergeConfigs

Returns

Memberof

Parameters

commonConfigs: any

specificConfigs: any

Optional extendedConfigs: any

Returns any

validateCanChange

Returns

Memberof

`Private` _providerExtendedOptions

`Private` _providerOptions

`Protected` validateBoolean

`Protected` validateDate

`Protected` validateInRange

`Rest` ...args: unknown[]

`Protected` validateNumber

`Protected` validateString

`Protected` validateTime

`Protected` mergeConfigs

`Optional` extendedConfigs: any

`Private` _getArrowConfig

`Private` _getDirectionConfig

`Private` _getPaginationConfig