Skip to content

Commit 498e677

Browse files
authored
docs(mobile): fix markdown list formatting in docs (#364)
1 parent e7ea454 commit 498e677

3 files changed

Lines changed: 24 additions & 3 deletions

File tree

packages/mobile/src/utils/isIOS/isIOS.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# isIOS
22

3-
`isIOS` is a utility function that detects whether the current device is running iOS or iPadOS. Notes on platform inconsistencies: - Prior to iPadOS 13, iPads reported their platform as "iPad" (or matched /iPad/ in UA). - Starting from iPadOS 13, Apple changed the platform string to "MacIntel" to make websites treat iPadOS as desktop-class Safari. However, these devices still expose multi-touch capabilities.
3+
`isIOS` is a utility function that detects whether the current device is running iOS or iPadOS.
4+
5+
Notes on platform inconsistencies:
6+
7+
- Prior to iPadOS 13, iPads reported their platform as "iPad" (or matched /iPad/ in UA).
8+
- Starting from iPadOS 13, Apple changed the platform string to "MacIntel" to make websites treat iPadOS as desktop-class Safari. However, these devices still expose multi-touch capabilities.
49

510
## Interface
611

packages/mobile/src/utils/subscribeKeyboardHeight/ko/subscribeKeyboardHeight.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# subscribeKeyboardHeight
22

3-
`subscribeKeyboardHeight`는 화면 키보드 높이의 변경 사항을 구독하는 유틸리티 함수에요. 제공된 콜백은 키보드 높이가 변경될 때마다 호출돼요. 키보드가 나타나거나 사라지거나 크기가 변경될 때 등이 포함돼요. 내부적으로 이 함수는 Visual Viewport에서 `resize``scroll` 이벤트를 모두 듣습니다: - `resize`: 시각적 뷰포트 높이가 변경될 때 트리거됨 - `scroll`: 시각적 뷰포트 오프셋이 변경될 때 트리거됨(iOS의 경우 뷰포트가 리사이징 없이 이동할 수 있어 중요함) 성능 최적화: - 과도한 콜백 호출을 방지하기 위해 기본적으로 쓰로틀링(16ms, 약 60fps) - 높이가 변경되지 않았을 때 콜백을 건너뛰기
3+
`subscribeKeyboardHeight`는 화면 키보드 높이의 변경 사항을 구독하는 유틸리티 함수에요. 제공된 콜백은 키보드 높이가 변경될 때마다 호출돼요. 키보드가 나타나거나 사라지거나 크기가 변경될 때 등이 포함돼요. 내부적으로 이 함수는 Visual Viewport에서 `resize``scroll` 이벤트를 모두 듣습니다:
4+
5+
- `resize`: 시각적 뷰포트 높이가 변경될 때 트리거됨
6+
- `scroll`: 시각적 뷰포트 오프셋이 변경될 때 트리거됨(iOS의 경우 뷰포트가 리사이징 없이 이동할 수 있어 중요함)
7+
8+
성능 최적화:
9+
10+
- 과도한 콜백 호출을 방지하기 위해 기본적으로 쓰로틀링(16ms, 약 60fps)
11+
- 높이가 변경되지 않았을 때 콜백을 건너뛰기
412

513
## 인터페이스
614

packages/mobile/src/utils/subscribeKeyboardHeight/subscribeKeyboardHeight.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# subscribeKeyboardHeight
22

3-
`subscribeKeyboardHeight` is a utility function that subscribes to changes in the on-screen keyboard height. The provided callback is invoked whenever the keyboard height may change, including when the keyboard appears, disappears, or changes size. Internally, this function listens to both `resize` and `scroll` events on the Visual Viewport: - `resize`: triggered when the visual viewport height changes - `scroll`: triggered when the visual viewport offset changes (important for iOS where the viewport can shift without resizing) Performance optimizations: - Throttled by default (16ms, ~60fps) to prevent excessive callback invocations - Skips callback when height hasn't changed (deduplication)
3+
`subscribeKeyboardHeight` is a utility function that subscribes to changes in the on-screen keyboard height. The provided callback is invoked whenever the keyboard height may change, including when the keyboard appears, disappears, or changes size. Internally, this function listens to both `resize` and `scroll` events on the Visual Viewport:
4+
5+
- `resize`: triggered when the visual viewport height changes
6+
- `scroll`: triggered when the visual viewport offset changes (important for iOS where the viewport can shift without resizing)
7+
8+
Performance optimizations:
9+
10+
- Throttled by default (16ms, ~60fps) to prevent excessive callback invocations
11+
- Skips callback when height hasn't changed (deduplication)
412

513
## Interface
614

0 commit comments

Comments
 (0)