Class SnapSlide

Index

Constructors

constructor

new SnapSlide(
_element: null | HTMLElement,
initProps?: ISnapSlideProps,
): SnapSlide
Parameters
- _element: null | HTMLElement
- initProps: ISnapSlideProps = {}
Returns SnapSlide
- Defined in src/components/Snap/Slide/index.ts:6

Properties

`Protected`_coord

_coord: number = 0

Current coordinate

`Protected`_domSize

_domSize: undefined | number

Size of the element

`Protected`_element

_element: null | HTMLElement

`Protected`_id

_id: string

Slide id

`Protected`_index

_index: number

Slide index

`Protected`_isAppended

_isAppended: boolean = false

If the slide is appended

`Protected`_isVisible

_isVisible: boolean = false

If the slide is visible

`Protected` `Optional`_onResize

_onResize?: IOnResize

Events on slide resize

`Protected`_progress

_progress: number = 0

Current progress of slide movement: from -1 to 1

`Protected`_props

_props: Required<ISnapSlideProps>

Slide props

`Protected` `Optional`_snap

_snap?: Snap<ISnapCallbacksMap, ISnapStaticProps, ISnapMutableProps>

Snap component

`Protected`_staticCoord

_staticCoord: number = 0

Static coordinate (as if the slide was never moved)

Accessors

coord

get coord(): number
Current coordinate

Returns number
- Defined in src/components/Snap/Slide/index.ts:86

element

get element(): null | HTMLElement
Slide element

Returns null | HTMLElement
- Defined in src/components/Snap/Slide/index.ts:28

id

get id(): string
Slide id

Returns string
- Defined in src/components/Snap/Slide/index.ts:44

index

get index(): number
Slide index

Returns number
- Defined in src/components/Snap/Slide/index.ts:52

isVisible

get isVisible(): boolean
Check if the slide is visible

Returns boolean
- Defined in src/components/Snap/Slide/index.ts:145

magnets

get magnets(): number[]
Get magnets with static coordinates but dynamic alignment

Returns number[]
- Defined in src/components/Snap/Slide/index.ts:217

progress

get progress(): number
Current progress of slide movement: from -1 to 1

Returns number
- Defined in src/components/Snap/Slide/index.ts:111

props

get props(): Required<ISnapSlideProps>
Slide properties

Returns Required<ISnapSlideProps>
- Defined in src/components/Snap/Slide/index.ts:36

size

get size(): number
Slide size in pixels

Returns number
- Defined in src/components/Snap/Slide/index.ts:126

sizeProp

get sizeProp(): string | number
Size property

Returns string | number
- Defined in src/components/Snap/Slide/index.ts:121

`Protected`snap

get snap(): | undefined
| Snap<ISnapCallbacksMap, ISnapStaticProps, ISnapMutableProps>
Snap component

Returns undefined | Snap<ISnapCallbacksMap, ISnapStaticProps, ISnapMutableProps>
- Defined in src/components/Snap/Slide/index.ts:60

staticCoord

get staticCoord(): number
Static coordinate (as if the slide was never moved)

Returns number
- Defined in src/components/Snap/Slide/index.ts:101

Methods

`Protected`_toggleAppend

_toggleAppend(): void
Toggle slide append/remove

Returns void
- Defined in src/components/Snap/Slide/index.ts:199

attach

attach(snap: Snap, index: number): void
Attach the slide to the Snap class
Parameters
- snap: Snap
- index: number
Returns void
- Defined in src/components/Snap/Slide/index.ts:170

detach

detach(): void
Detach the slide from the Snap class

Returns void
- Defined in src/components/Snap/Slide/index.ts:188

render

render(): void
Render the slide

Returns void
- Defined in src/components/Snap/Slide/index.ts:194

resize

resize(isManual?: boolean): void
Resize the slide & trigger snap reflow
Parameters
- isManual: boolean = false
Returns void
- Defined in src/components/Snap/Slide/index.ts:150

setCoord

setCoord(value: number): void
Current coordinate. Do not update it manually!
Parameters
- value: number
Returns void
- Defined in src/components/Snap/Slide/index.ts:91

setProgress

setProgress(value: number): void
Current progress of slide movement: from -1 to 1. Do not update it manually!
Parameters
- value: number
Returns void
- Defined in src/components/Snap/Slide/index.ts:116

setStaticCoord

setStaticCoord(value: number): void
Static coordinate (as if the slide was never moved). Do not update it manually! Alignment: start
Parameters
- value: number
Returns void
- Defined in src/components/Snap/Slide/index.ts:106

Class SnapSlide

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SnapSlide

Properties

Protected_coord

Protected_domSize

Protected_element

Protected_id

Protected_index

Protected_isAppended

Protected_isVisible

Protected Optional_onResize

Protected_progress

Protected_props

Protected Optional_snap

Protected_staticCoord

Accessors

coord

Returns number

element

Returns null | HTMLElement

id

Returns string

index

Returns number

isVisible

Returns boolean

magnets

Returns number[]

progress

Returns number

props

Returns Required<ISnapSlideProps>

size

Returns number

sizeProp

Returns string | number

Protectedsnap

Returns undefined | Snap<ISnapCallbacksMap, ISnapStaticProps, ISnapMutableProps>

staticCoord

Returns number

Methods

Protected_toggleAppend

Returns void

attach

Parameters

Returns void

detach

Returns void

render

Returns void

resize

Parameters

Returns void

setCoord

Parameters

Returns void

setProgress

Parameters

Returns void

setStaticCoord

Parameters

Returns void

Settings

On This Page

`Protected`_coord

`Protected`_domSize

`Protected`_element

`Protected`_id

`Protected`_index

`Protected`_isAppended

`Protected`_isVisible

`Protected` `Optional`_onResize

`Protected`_progress

`Protected`_props

`Protected` `Optional`_snap

`Protected`_staticCoord

`Protected`snap

`Protected`_toggleAppend