Skip to content

Commit

Permalink
v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
metonym committed Jan 1, 2024
1 parent b24ec5d commit 4f7013a
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 24 deletions.
58 changes: 35 additions & 23 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,90 +5,102 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.0.0](https://github.com/metonym/svelte-intersection-observer/releases/tag/v1.0.0) - 2024-01-01

**Breaking Changes**

- Remove `IntersectionObserverProps` or `Entry` TypeScript interfaces from `IntersectionObserver.svelte.d.ts`
- Drop support for bundled ESM/UMD; code is only distributed as Svelte files

**Fixes**

- `element` and `root` prop types should be `null | HTMLElement` to support TypeScript strict mode
- Add `exports` field to `package.json`

## [0.10.2](https://github.com/metonym/svelte-intersection-observer/releases/tag/v0.10.2) - 2024-01-01

**Fixes**

- add `exports` field to `package.json`
- Add `exports` field to `package.json`

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

**Fixes**

- fix `threshold` prop type to be `number | number[]`
- Fix `threshold` prop type to be `number | number[]`

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

**Features**

- mark `observer` for garbage collection after disconnecting
- Mark `observer` for garbage collection after disconnecting

**Documentation**

- make prop descriptions consistent with docs
- Make prop descriptions consistent with docs

**Refactoring**

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

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

**Documentation**

- add `let:` directive example
- update component prop descriptions
- use Svelte syntax highlighting for `on:observe`, `on:intersect` examples
- Add `let:` directive example
- Update component prop descriptions
- Use Svelte syntax highlighting for `on:observe`, `on:intersect` examples

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

**Documentation**

- update the "Once" example to include the `"svelte-intersection-observer"` import
- rename example `svite` to `vite`
- Update the "Once" example to include the `"svelte-intersection-observer"` import
- Rename example `svite` to `vite`

**Refactoring**

- inline `entry` prop typedef
- remove `@event`, `@slot` artifacts used by sveld to generate initial TypeScript definitions
- Inline `entry` prop typedef
- Remove `@event`, `@slot` artifacts used by sveld to generate initial TypeScript definitions

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

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

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

- use `.svelte.d.ts` extension for component TypeScript definition
- Use `.svelte.d.ts` extension for component TypeScript definition

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

**Documentation**

- add description for basic usage
- add `on:observe` example
- explain difference between `on:observe` and `on:intersect`
- document `IntersectionObserverEntry` interface
- re-order prop table so that `once` and `intersecting` are more prominent
- Add description for basic usage
- Add `on:observe` example
- Explain difference between `on:observe` and `on:intersect`
- Document `IntersectionObserverEntry` interface
- Re-order prop table so that `once` and `intersecting` are more prominent

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

**Features**

- re-initialize observer if `rootMargin` changes
- Re-initialize observer if `rootMargin` changes

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

**Fixes**

- move intersection observer instantiation to `onMount` to work in hydration use cases
- Move intersection observer instantiation to `onMount` to work in hydration use cases

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

**Features**

- export `observer` prop (type `IntersectionObserver`)
- dispatch "intersect" event if the observed element `isIntersecting` the viewport
- Export `observer` prop (type `IntersectionObserver`)
- Dispatch "intersect" event if the observed element `isIntersecting` the viewport

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

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "svelte-intersection-observer",
"version": "0.10.2",
"version": "1.0.0",
"license": "MIT",
"description": "Detect if an element is in the viewport using the Intersection Observer API",
"author": "Eric Liu (https://github.com/metonym)",
Expand Down

0 comments on commit 4f7013a

Please sign in to comment.