UNPKG

position-indicator

Version:

position indicator library

github.com/kunukn/position-indicator

kunukn/position-indicator

45 lines (25 loc) • 1.12 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
positionIndicator # positionIndicator ## Table of contents ### Interfaces - [CallbackParams](interfaces/callbackparams.md) - [Memory](interfaces/memory.md) - [Options](interfaces/options.md) - [PositionIndicatorInstance](interfaces/positionindicatorinstance.md) ### Type aliases - [eventType](README.md#eventtype) ### Functions - [createPositionIndicator](README.md#createpositionindicator) ## Type aliases ### eventType Ƭ **eventType**: ``"init"`` \| ``"scroll"`` \| ``"resize"`` \| ``"heightChange"`` Defined in: [index.ts:1](https://github.com/kunukn/position-indicator/blob/f248d85/src/index.ts#L1) ## Functions ### createPositionIndicator ▸ `Const` **createPositionIndicator**(`options`: [*Options*](interfaces/options.md)): [*PositionIndicatorInstance*](interfaces/positionindicatorinstance.md) #### Parameters | Name | Type | | :------ | :------ | | `options` | [*Options*](interfaces/options.md) | **Returns:** [*PositionIndicatorInstance*](interfaces/positionindicatorinstance.md) Defined in: [index.ts:119](https://github.com/kunukn/position-indicator/blob/f248d85/src/index.ts#L119)