haru-cat 0.0.2 → 0.0.3
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.
- package/CHANGELOG.md +16 -0
- package/README.ja.md +22 -0
- package/README.md +22 -0
- package/dist/HaruCat.d.ts +3 -1
- package/dist/index.cjs +1 -1
- package/dist/index.js +38 -15
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,22 @@
|
|
|
3
3
|
This file records notable changes to Haru Cat. It is maintained manually and
|
|
4
4
|
organized by release.
|
|
5
5
|
|
|
6
|
+
## 0.0.3 — 2026-07-26
|
|
7
|
+
|
|
8
|
+
### Added
|
|
9
|
+
|
|
10
|
+
- Add a `visible` prop for controlling whether Haru-kun is shown.
|
|
11
|
+
- Add a `fadeDuration` prop for customizing visibility transitions.
|
|
12
|
+
- Add controls to the development playground for checking visibility and fade
|
|
13
|
+
duration.
|
|
14
|
+
|
|
15
|
+
### Changed
|
|
16
|
+
|
|
17
|
+
- Respect the user's reduced-motion preference by disabling visibility fades.
|
|
18
|
+
- Mark the package as a Client Component for React Server Components
|
|
19
|
+
environments.
|
|
20
|
+
- Fall back safely when the environment does not provide `matchMedia`.
|
|
21
|
+
|
|
6
22
|
## 0.0.2 — 2026-07-26
|
|
7
23
|
|
|
8
24
|
### Added
|
package/README.ja.md
CHANGED
|
@@ -47,6 +47,23 @@ export default function App() {
|
|
|
47
47
|
`offsetX`と`offsetY`は、それぞれの方向で`offset`より優先されます。
|
|
48
48
|
`bottom-center`では、横方向の余白は適用されません。
|
|
49
49
|
|
|
50
|
+
`visible`を使用すると、ハルくんの表示と非表示を切り替えられます。
|
|
51
|
+
`visible`の値を切り替えると、初期設定では300ミリ秒かけてフェードイン・フェードアウトします。
|
|
52
|
+
|
|
53
|
+
```tsx
|
|
54
|
+
<HaruCat visible={isVisible} />
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
フェード時間を変更する場合は、`fadeDuration`へミリ秒単位で指定します。
|
|
58
|
+
`0`を指定すると、フェードせず即座に切り替わります。
|
|
59
|
+
|
|
60
|
+
```tsx
|
|
61
|
+
<HaruCat visible={isVisible} fadeDuration={500} />
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
フェードは`visible`の値が変更されたときに適用されます。
|
|
65
|
+
`<HaruCat />`は初回レンダー時から表示されるため、ページ読み込み時のフェードインは行いません。
|
|
66
|
+
|
|
50
67
|
## Props
|
|
51
68
|
|
|
52
69
|
| Prop | 型 | 初期値 | 説明 |
|
|
@@ -57,6 +74,8 @@ export default function App() {
|
|
|
57
74
|
| `offsetX` | `number` | `undefined` | 左端または右端からの距離です。横方向では`offset`より優先されます。 |
|
|
58
75
|
| `offsetY` | `number` | `undefined` | 画面下端からの距離です。縦方向では`offset`より優先されます。 |
|
|
59
76
|
| `responsive` | `boolean` | `true` | 小さい画面で、画像の大きさを画面の短い辺の30%以下に調整します。 |
|
|
77
|
+
| `visible` | `boolean` | `true` | ハルくんを表示するかどうかを指定します。 |
|
|
78
|
+
| `fadeDuration` | `number` | `300` | フェードイン・フェードアウトの時間をミリ秒単位で指定します。`0`未満の値は`0`として扱われます。 |
|
|
60
79
|
| `zIndex` | `number` | `9999` | コンポーネントのCSS `z-index`です。 |
|
|
61
80
|
| `className` | `string` | `undefined` | 外側の要素に設定するクラス名です。 |
|
|
62
81
|
|
|
@@ -66,6 +85,9 @@ export default function App() {
|
|
|
66
85
|
|
|
67
86
|
小さい画面でも`size`を正確なピクセル値として使用したい場合は、`responsive={false}`を指定してください。
|
|
68
87
|
|
|
88
|
+
Haru Catは、利用者の`prefers-reduced-motion`設定に対応しています。
|
|
89
|
+
動きを減らす設定が有効な場合、表示と非表示はフェードせず即座に切り替わります。
|
|
90
|
+
|
|
69
91
|
## TypeScript
|
|
70
92
|
|
|
71
93
|
Propsと表示位置の型をパッケージから読み込めます。
|
package/README.md
CHANGED
|
@@ -48,6 +48,23 @@ different.
|
|
|
48
48
|
`offsetX` and `offsetY` override `offset` on their respective axes. The
|
|
49
49
|
horizontal offset does not apply to `bottom-center`.
|
|
50
50
|
|
|
51
|
+
Use `visible` to show or hide Haru-kun. Changes fade over 300 milliseconds by
|
|
52
|
+
default.
|
|
53
|
+
|
|
54
|
+
```tsx
|
|
55
|
+
<HaruCat visible={isVisible} />
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Customize the fade duration in milliseconds with `fadeDuration`. Set it to `0`
|
|
59
|
+
for an immediate change.
|
|
60
|
+
|
|
61
|
+
```tsx
|
|
62
|
+
<HaruCat visible={isVisible} fadeDuration={500} />
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
The fade applies when `visible` changes. `<HaruCat />` is shown immediately on
|
|
66
|
+
its initial render.
|
|
67
|
+
|
|
51
68
|
## Props
|
|
52
69
|
|
|
53
70
|
| Prop | Type | Default | Description |
|
|
@@ -58,6 +75,8 @@ horizontal offset does not apply to `bottom-center`.
|
|
|
58
75
|
| `offsetX` | `number` | `undefined` | Left or right distance in pixels. Overrides `offset` on the horizontal axis. |
|
|
59
76
|
| `offsetY` | `number` | `undefined` | Bottom distance in pixels. Overrides `offset` on the vertical axis. |
|
|
60
77
|
| `responsive` | `boolean` | `true` | Limits the image to 30% of the viewport's shorter side on smaller screens. |
|
|
78
|
+
| `visible` | `boolean` | `true` | Whether Haru-kun is shown. |
|
|
79
|
+
| `fadeDuration` | `number` | `300` | Fade-in and fade-out duration in milliseconds. Values below `0` are treated as `0`. |
|
|
61
80
|
| `zIndex` | `number` | `9999` | CSS `z-index` of the component. |
|
|
62
81
|
| `className` | `string` | `undefined` | Class name applied to the wrapper element. |
|
|
63
82
|
|
|
@@ -69,6 +88,9 @@ the safe-area insets provided by the browser to the configured edge offsets.
|
|
|
69
88
|
Set `responsive={false}` when `size` must remain an exact pixel size on small
|
|
70
89
|
screens.
|
|
71
90
|
|
|
91
|
+
Haru Cat respects the user's `prefers-reduced-motion` setting. When reduced
|
|
92
|
+
motion is requested, visibility changes happen immediately instead of fading.
|
|
93
|
+
|
|
72
94
|
## TypeScript
|
|
73
95
|
|
|
74
96
|
The component props and position type are exported from the package.
|
package/dist/HaruCat.d.ts
CHANGED
|
@@ -6,7 +6,9 @@ export type HaruCatProps = {
|
|
|
6
6
|
offsetX?: number;
|
|
7
7
|
offsetY?: number;
|
|
8
8
|
responsive?: boolean;
|
|
9
|
+
visible?: boolean;
|
|
10
|
+
fadeDuration?: number;
|
|
9
11
|
zIndex?: number;
|
|
10
12
|
className?: string;
|
|
11
13
|
};
|
|
12
|
-
export declare function HaruCat({ position, size, offset, offsetX, offsetY, responsive, zIndex, className, }: HaruCatProps): import("react").JSX.Element;
|
|
14
|
+
export declare function HaruCat({ position, size, offset, offsetX, offsetY, responsive, visible, fadeDuration, zIndex, className, }: HaruCatProps): import("react").JSX.Element;
|