viewport-truth 1.0.5 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +12 -10
  2. package/package.json +13 -2
package/README.md CHANGED
@@ -18,7 +18,7 @@ npm i viewport-truth
18
18
  ```
19
19
 
20
20
 
21
- ### Quick Start
21
+ ## Quick Start
22
22
  Minimal flow: import → create → subscribe → get { width, height, isKeyboardOpen, isStable }.
23
23
 
24
24
  ```js
@@ -97,10 +97,6 @@ stable: ${v.isStable}`;
97
97
  </script>
98
98
  ```
99
99
 
100
- ### Smoke test (clean environment)
101
- Step-by-step guide: **[smoke-test.md](https://github.com/AntonVoronezh/viewport-truth/blob/main//docs/smoke-test.md)**.
102
-
103
-
104
100
  ## Features
105
101
  A few concrete, technical reasons it behaves well on mobile:
106
102
 
@@ -134,13 +130,19 @@ Framework adapters:
134
130
 
135
131
  Full types and signatures: see `dist/*.d.ts` (or TypeScript IntelliSense).
136
132
 
137
- Adapter Docs: [React](https://github.com/AntonVoronezh/viewport-truth/blob/main/docs/react.md) •
138
- [Vue](https://github.com/AntonVoronezh/viewport-truth/blob/main/docs/vue.md) •
139
- [Svelte](https://github.com/AntonVoronezh/viewport-truth/blob/main/docs/svelte.md) •
140
- [Solid](https://github.com/AntonVoronezh/viewport-truth/blob/main/docs/solid.md) •
141
- [Angular](https://github.com/AntonVoronezh/viewport-truth/blob/main/docs/angular.md)
133
+ Adapter Docs: [React](https://antonvoronezh.github.io/viewport-truth/react) •
134
+ [Vue](https://antonvoronezh.github.io/viewport-truth/vue) •
135
+ [Svelte](https://antonvoronezh.github.io/viewport-truth/svelte) •
136
+ [Solid](https://antonvoronezh.github.io/viewport-truth/solid) •
137
+ [Angular](https://antonvoronezh.github.io/viewport-truth/angular)
142
138
  > **Tip:** Open links in a new tab with **Ctrl+Click** (Windows/Linux) or **Cmd+Click** (macOS).
143
139
 
140
+ ### Links
141
+ [FAQ](https://antonvoronezh.github.io/viewport-truth/faq) •
142
+ [Common pitfalls](https://antonvoronezh.github.io/viewport-truth/common-pitfalls) •
143
+ [Smoke test (clean environment)](https://antonvoronezh.github.io/viewport-truth/smoke-test) •
144
+ [Versioning policy](https://github.com/AntonVoronezh/viewport-truth/blob/main/SEMVER_POLICY.md)
145
+
144
146
  ## Support the project
145
147
 
146
148
  > “We ate the Geometry Hell for you: jumping `100vh`, jittery `resize`, modals under the keyboard.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "viewport-truth",
3
- "version": "1.0.5",
3
+ "version": "1.0.6",
4
4
  "description": "Tiny zero‑config VisualViewport-first store for accurate visible viewport size in CSS pixels. Detects virtual keyboard, stabilizes resize/scroll jitter, and is SSR-safe across frameworks.",
5
5
  "author": {
6
6
  "name": "AntonVoronezh",
@@ -35,7 +35,10 @@
35
35
  "clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
36
36
  "typecheck": "tsc -p tsconfig.json --noEmit",
37
37
  "test": "vitest run",
38
- "test:watch": "vitest"
38
+ "test:watch": "vitest",
39
+ "docs:dev": "vitepress dev docs",
40
+ "docs:build": "vitepress build docs",
41
+ "docs:preview": "vitepress preview docs"
39
42
  },
40
43
  "keywords": [
41
44
  "viewport",
@@ -103,6 +106,12 @@
103
106
  "devDependencies": {
104
107
  "@angular/common": "^17.3.0",
105
108
  "@angular/core": "^17.3.0",
109
+ "@semantic-release/changelog": "^6.0.3",
110
+ "@semantic-release/commit-analyzer": "^11.1.0",
111
+ "@semantic-release/git": "^10.0.1",
112
+ "@semantic-release/github": "^10.3.5",
113
+ "@semantic-release/npm": "^13.1.3",
114
+ "@semantic-release/release-notes-generator": "^12.1.0",
106
115
  "@types/node": "^22.0.0",
107
116
  "@types/react": "^18.3.0",
108
117
  "@types/react-dom": "^18.3.0",
@@ -111,9 +120,11 @@
111
120
  "react": "^18.3.0",
112
121
  "react-dom": "^18.3.0",
113
122
  "rxjs": "^7.8.0",
123
+ "semantic-release": "^23.1.1",
114
124
  "solid-js": "^1.9.0",
115
125
  "svelte": "^4.2.0",
116
126
  "typescript": "^5.5.4",
127
+ "vitepress": "^1.6.4",
117
128
  "vitest": "^4.0.18",
118
129
  "vue": "^3.5.0"
119
130
  },