Class Store

Hierarchy

Store

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Store(transitions?: ITransitionPage[]): Store

- Defined in packages/core/src/modules/Store.ts:60
Init store.

Parameters
- Default value transitions: ITransitionPage[] = []
Returns Store

Properties

Private _rules

_rules: IRule[] = [{name: 'namespace',type: 'strings',},{name: 'custom',type: 'function',},]

Rules for transition resolution.

Defaults:

namespace
custom

all

all: ITransitionPage[] = []

All registered transitions.

logger

logger: Logger = new Logger('@barba/core')

once

once: ITransitionOnce[] = []

"Once only" registered transitions.

page

page: ITransitionPage[] = []

"Page only" registered transitions.

Methods

Private _addPriority

_addPriority(t: ITransitionPage): ITransitionPage

- Defined in packages/core/src/modules/Store.ts:329
Parameters
- t: ITransitionPage
Returns ITransitionPage

Private _calculatePriority

_calculatePriority(t: ITransitionPage, ruleName: RuleName, ruleIndex: number): number

- Defined in packages/core/src/modules/Store.ts:304
Calculate transition priority.

Based on:
- rule "position" (index) give tens, hundreds, thousands, …
- from/to properties give units (0, 1 or 2)
Parameters
- t: ITransitionPage
- ruleName: RuleName
- ruleIndex: number
Returns number

Private _check

_check(transition: ITransitionPage, rule: IRule, data: ITransitionData, match: any, direction?: "from" | "to"): boolean

- Defined in packages/core/src/modules/Store.ts:211
Check if transition apply.

Based on rule, page data and optional direction:
1. transition has no rule "property":
  - always returns true
2. transition has rule "property":
  - "strings" should be present on both side (transition + page) and match
  - "function" should return true
Parameters
- transition: ITransitionPage
- rule: IRule
- data: ITransitionData
- match: any
- Optional direction: "from" | "to"
Returns boolean

add

add(type: "rule" | "transition", data: any): void

- Defined in packages/core/src/modules/Store.ts:77
Add rule or transition.

Parameters
- type: "rule" | "transition"
- data: any
Returns void

resolve

resolve(data: ITransitionData, filters?: ITransitionFilters): ITransitionOnce | ITransitionPage

- Defined in packages/core/src/modules/Store.ts:96
Resolve transition.

Parameters
- data: ITransitionData
- Default value filters: ITransitionFilters = {}
Returns ITransitionOnce | ITransitionPage

update

update(): void

- Defined in packages/core/src/modules/Store.ts:183
Update store.
- Reorder transition by priorities
- Get wait indicator
- Get once transitions
Returns void

Generated using TypeDoc