Skip to content

Commit df7e274

Browse files
authored
docs: move list of utils to readme (#42)
1 parent d32406a commit df7e274

File tree

2 files changed

+20
-23
lines changed

2 files changed

+20
-23
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,26 @@ To install `relit`, simply add it as a dependency to your lit project:
1313
npm i -S relit
1414
```
1515

16-
## Usage
17-
18-
For usage, see the [docs](./docs/index.md) of each available utility.
16+
## List of utilities
17+
18+
The following is the full list of available utilities:
19+
20+
- [activeElement](./activeElement.md) - observable [document.activeElement](https://developer.mozilla.org/en-US/docs/Web/API/Document/activeElement)
21+
- [bindInput](./bindInput.md) - two-way bindings of form controls/inputs
22+
- [documentVisibility](./documentVisibility.md) - observable [document.visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState)
23+
- [elementSize](./elementSize.md) - element width and height
24+
- [elementVisibility](./elementVisibility.md) - element visibility
25+
- [head](./head.md) - `<head>` tag management
26+
- [itemSelection](./itemSelection.md) - manages selection within an array of items
27+
- [keyBinding](./keyBinding.md) - key bindings (shortcuts) manager
28+
- [localStorage](./localStorage.md) - items in [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)
29+
- [markdown](./markdown.md) - markdown processing via [marked](https://github.com/markedjs/marked)
30+
- [onLongPress](./onLongPress.md) - fire callback on long press
31+
- [permissions](./permissions.md) - track the state of a browser [permission](https://developer.mozilla.org/en-US/docs/Web/API/Permissions/query)
32+
- [propertyHistory](./propertyHistory.md) - track the history of a property with undo/redo
33+
- [sessionStorage](./sessionStorage.md) - items in [sessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)
34+
- [slot](./slot.md) - track slotted elements
35+
- [windowScroll](./windowScroll.md) - track the window scroll offset
1936

2037
## License
2138

docs/index.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)