WebViewKit is a comprehensive suite of TypeScript libraries designed to enhance and simplify the development of WebView-based applications. Our goal is to provide developers with powerful tools for detection, analysis, optimization, and communication bridging in WebView environments.
WebViewKit currently consists of the following packages:
A lightweight TypeScript library for detecting and analyzing user environments, particularly useful for identifying WebView environments.
- Accurate detection of operating systems, browsers, and device types
- Specialized WebView detection
- TypeScript support with comprehensive type definitions
- Easy-to-use API for retrieving environment information
Learn more about @webviewkit/environment
A flexible and type-safe TypeScript library for facilitating communication between WebView and native platforms in hybrid mobile applications.
- Type-safe communication between WebView and native platforms
- Intelligent version-aware API handling
- Support for iOS, Android, and React Native
- Customizable error handling
- Automatic selection of the most appropriate handler based on semantic versioning
Learn more about @webviewkit/bridge
An automatic documentation generator for WebView bridge interfaces, designed to work seamlessly with @webviewkit/bridge.
- Automatic generation of API documentation for WebView bridge interfaces
- Support for Markdown and JSON output formats
- Customizable configuration for include/exclude directories
- Seamless integration with TypeScript projects
Learn more about @webviewkit/bridgedocs
To get started with WebViewKit, you can install the packages you need using npm, yarn, or pnpm:
npm install @webviewkit/environment @webviewkit/bridge @webviewkit/bridgedocs
# or
yarn add @webviewkit/environment @webviewkit/bridge @webviewkit/bridgedocs
# or
pnpm add @webviewkit/environment @webviewkit/bridge @webviewkit/bridgedocsWe welcome contributions to WebViewKit! If you're interested in contributing, please:
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Please make sure to update tests as appropriate and adhere to the code style of the project.
This project is licensed under the MIT License - see the LICENSE file for details.
If you have any questions, feel free to reach out or open an issue in the GitHub repository.
Happy coding with WebViewKit!