Skip to content

Commit 4490500

Browse files
committed
1.0.3
1 parent 4344447 commit 4490500

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 👔 Necktie – a simple DOM binding tool
22

3-
`Necktie` is a library that binds your logic to the **Document Object Model** elements in an easy way. It has only `~3 kB` (UMD, minified).
3+
`Necktie` is a library that binds your logic to the **Document Object Model** elements in an easy way. It has only `~ 3kB` (UMD, minified).
44

55

66
## How it works
@@ -29,8 +29,9 @@ necktie.bind('.form-component input[data-name]', (node) => {
2929

3030
## Installation
3131

32-
Using npm: `npm install @lesniewski.pro/necktie`.
33-
Using yarn: `yarn add @lesniewski.pro/necktie`.
32+
Using:
33+
- npm: `npm install @lesniewski.pro/necktie`
34+
- yarn: `yarn add @lesniewski.pro/necktie`
3435

3536

3637
## Documentation
@@ -49,12 +50,12 @@ The library comes with CJS, ESM and UMD modules. **TypeScript** types are also a
4950
| `bind(selector: string, callback: Callback): this` | Binds a callback function with a given selector. |
5051
| `bindClass(selector: string, BindableComponent: Bindable): this` | Binds a `Bindable` class with a given selector. |
5152
| `observeAttributes(isEnabled?: boolean): this` | Looks for attributes changes, for example `class` or `data-*`. Rebinds registered functions if necessary. **WARNING!** Use with caution, this might be expensive. |
52-
| `startListening(): this` | Runs callbacks or Bindable classes on registered selectors, starts listening for DOM changes. |
53+
| `startListening(): this` | Runs callbacks or `Bindable` classes on registered selectors, starts listening for DOM changes. |
5354

5455
#### `Bindable` class
5556
| Method | Description |
5657
| --------------------------------------------------------------------- | --- |
57-
| `constructor(node?: Node): this` | Creates a new Bindable instance |
58+
| `constructor(node?: Node): this` | Creates a new `Bindable` instance. |
5859
| | |
5960
| `destroy(destroyedNode? Node): void` | A clean up method, called when a DOM element has been removed. |
6061

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@lesniewski.pro/necktie",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"main": "dist/necktie.cjs.js",
55
"module": "dist/necktie.esm.js",
66
"browser": "dist/necktie.umd.js",

0 commit comments

Comments
 (0)