Skip to content

Commit 4f7013a

Browse files
committed
v1.0.0
1 parent b24ec5d commit 4f7013a

File tree

2 files changed

+36
-24
lines changed

2 files changed

+36
-24
lines changed

CHANGELOG.md

+35-23
Original file line numberDiff line numberDiff line change
@@ -5,90 +5,102 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.0.0](https://github.com/metonym/svelte-intersection-observer/releases/tag/v1.0.0) - 2024-01-01
9+
10+
**Breaking Changes**
11+
12+
- Remove `IntersectionObserverProps` or `Entry` TypeScript interfaces from `IntersectionObserver.svelte.d.ts`
13+
- Drop support for bundled ESM/UMD; code is only distributed as Svelte files
14+
15+
**Fixes**
16+
17+
- `element` and `root` prop types should be `null | HTMLElement` to support TypeScript strict mode
18+
- Add `exports` field to `package.json`
19+
820
## [0.10.2](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.10.2) - 2024-01-01
921

1022
**Fixes**
1123

12-
- add `exports` field to `package.json`
24+
- Add `exports` field to `package.json`
1325

1426
## [0.10.1](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.10.1) - 2023-07-20
1527

1628
**Fixes**
1729

18-
- fix `threshold` prop type to be `number | number[]`
30+
- Fix `threshold` prop type to be `number | number[]`
1931

2032
## [0.10.0](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.10.0) - 2021-12-29
2133

2234
**Features**
2335

24-
- mark `observer` for garbage collection after disconnecting
36+
- Mark `observer` for garbage collection after disconnecting
2537

2638
**Documentation**
2739

28-
- make prop descriptions consistent with docs
40+
- Make prop descriptions consistent with docs
2941

3042
**Refactoring**
3143

32-
- omit redundant `null` from `element` and `root` types as `HTMLElement` is already nullable
44+
- Omit redundant `null` from `element` and `root` types as `HTMLElement` is already nullable
3345

3446
## [0.9.2](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.9.2) - 2021-11-26
3547

3648
**Documentation**
3749

38-
- add `let:` directive example
39-
- update component prop descriptions
40-
- use Svelte syntax highlighting for `on:observe`, `on:intersect` examples
50+
- Add `let:` directive example
51+
- Update component prop descriptions
52+
- Use Svelte syntax highlighting for `on:observe`, `on:intersect` examples
4153

4254
## [0.9.1](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.9.1) - 2021-10-25
4355

4456
**Documentation**
4557

46-
- update the "Once" example to include the `"svelte-intersection-observer"` import
47-
- rename example `svite` to `vite`
58+
- Update the "Once" example to include the `"svelte-intersection-observer"` import
59+
- Rename example `svite` to `vite`
4860

4961
**Refactoring**
5062

51-
- inline `entry` prop typedef
52-
- remove `@event`, `@slot` artifacts used by sveld to generate initial TypeScript definitions
63+
- Inline `entry` prop typedef
64+
- Remove `@event`, `@slot` artifacts used by sveld to generate initial TypeScript definitions
5365

5466
## [0.9.0](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.9.0) - 2021-10-05
5567

56-
- improve TypeScript definitions for dispatched events
68+
- Improve TypeScript definitions for dispatched events
5769
- `on:observe`: `event.detail.isIntersecting` is a `boolean`
5870
- `on:intersect`: `event.detail.isIntersecting` can only be `true`
5971

6072
## [0.8.0](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.8.0) - 2021-09-02
6173

62-
- use `.svelte.d.ts` extension for component TypeScript definition
74+
- Use `.svelte.d.ts` extension for component TypeScript definition
6375

6476
## [0.7.1](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.7.1) - 2021-07-05
6577

6678
**Documentation**
6779

68-
- add description for basic usage
69-
- add `on:observe` example
70-
- explain difference between `on:observe` and `on:intersect`
71-
- document `IntersectionObserverEntry` interface
72-
- re-order prop table so that `once` and `intersecting` are more prominent
80+
- Add description for basic usage
81+
- Add `on:observe` example
82+
- Explain difference between `on:observe` and `on:intersect`
83+
- Document `IntersectionObserverEntry` interface
84+
- Re-order prop table so that `once` and `intersecting` are more prominent
7385

7486
## [0.7.0](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.7.0) - 2021-04-23
7587

7688
**Features**
7789

78-
- re-initialize observer if `rootMargin` changes
90+
- Re-initialize observer if `rootMargin` changes
7991

8092
## [0.6.1](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.6.1) - 2021-04-03
8193

8294
**Fixes**
8395

84-
- move intersection observer instantiation to `onMount` to work in hydration use cases
96+
- Move intersection observer instantiation to `onMount` to work in hydration use cases
8597

8698
## [0.6.0](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.6.0) - 2021-02-24
8799

88100
**Features**
89101

90-
- export `observer` prop (type `IntersectionObserver`)
91-
- dispatch "intersect" event if the observed element `isIntersecting` the viewport
102+
- Export `observer` prop (type `IntersectionObserver`)
103+
- Dispatch "intersect" event if the observed element `isIntersecting` the viewport
92104

93105
## [0.5.0](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.5.0) - 2021-01-20
94106

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "svelte-intersection-observer",
3-
"version": "0.10.2",
3+
"version": "1.0.0",
44
"license": "MIT",
55
"description": "Detect if an element is in the viewport using the Intersection Observer API",
66
"author": "Eric Liu (https://github.com/metonym)",

0 commit comments

Comments
 (0)