docs(mobile): add documentation for utils #314
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…sePageVisibility, and useScrollDirection hooks - Refined descriptions and examples for clarity and consistency. - Improved parameter and return value sections across all hooks. - Removed outdated examples and notes to streamline documentation. - Enhanced Korean translations for useNetworkStatus and usePageVisibility hooks.
- Updated hero text to better describe the library as a "Lightweight and powerful React utility library." - Revised features section to include clearer titles and detailed descriptions, emphasizing zero dependencies, test coverage, and comprehensive documentation. - Added new logo and symbol SVG images to improve visual branding.
- Changed code block syntax from single backticks to triple backticks for better rendering. - Ensured consistency across examples in useBodyScrollLock, useNetworkStatus, usePageVisibility, and useScrollDirection documentation.
- Add fallback to use JSDoc first line when @description tag is missing - Fix dotenv loading by explicitly specifying .env path - Change translation model from gpt-4o to gpt-3.5-turbo
- Split bodyScrollLock into enableBodyScrollLock and disableBodyScrollLock - Split device into isIOS and isAndroid - Move keyboard utils to individual folders - Move safeArea utils to individual folder - Move isServer to individual folder
- Add English and Korean documentation for 9 utils - isServer, enableBodyScrollLock, disableBodyScrollLock - isIOS, isAndroid, getKeyboardHeight - isKeyboardVisible, subscribeKeyboardHeight, getSafeAreaInset
Contributor
|
Size Change: 0 B 🆕 Total Size: 0 B |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes
1. Script Improvements
@descriptiontag is missing2. Utils Folder Restructure
bodyScrollLock.tsenableBodyScrollLock/,disableBodyScrollLock/device/device.tsisIOS/,isAndroid/keyboard/*.tsgetKeyboardHeight/,isKeyboardVisible/,subscribeKeyboardHeight/safeArea/*.tsgetSafeAreaInset/isServer.tsisServer/3. Documentation Added (18 files)
4. VitePress Configuration
Test plan
yarn typecheckpassesyarn testpasses (174 tests)yarn docs:dev- documentation renders correctly