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)