0d7a91e69e
|
||
|---|---|---|
| .github/ISSUE_TEMPLATE | ||
| .storybook | ||
| docs | ||
| policheck | ||
| src | ||
| .eslintrc.js | ||
| .gitignore | ||
| .npmignore | ||
| .prettierignore | ||
| .prettierrc | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE | ||
| LICENSE-CODE | ||
| README.md | ||
| SECURITY.md | ||
| api-extractor.json | ||
| azure-pipelines.yml | ||
| package-lock.json | ||
| package.json | ||
| rollup.config.js | ||
| tsconfig.json | ||
README.md
Visual Studio Code Webview Toolkit
Introduction
The VS Code Webview Toolkit is a component library made specifically for building webview-based extensions in VS Code.
This toolkit was created to give people the tools to build webview experiences that are consistent with the rest of VS Code. Features of the library include:
- Implements The VS Code Design Language: All components implement the VS Code design language enabling developers to create extensions that have a consistent look and feel with the rest of VS Code right out of the box.
- Plays Nice With Your Tech Stack: The library is built using web component APIs meaning no matter what tech stack your using (React, Angular, Vanilla JS, etc.) the component library will play nice.
- Theming As A First Class Citizen: All of the components were designed with theming in mind and the toolkit ships with utilities that allow extension developers to easily tap into and automatically consume VS Code color theme changes.
- Accessible Out Of The Box: All components ship with web standard compliant ARIA labels and keyboard navigation meaning you don't have to worry about accessibility.
Getting Started
Follow the Getting Started Guide.
Documentation
Beyond the Getting Started Guide, further documentation can be found in the following places:
- Component Docs
- Storybook – Interactive Component Sandbox
- Toolkit Extension Samples
- VS Code Webview Guide
- VS Code Webview Guidelines
- VS Code Extension API Docs
Contributing
This project welcomes contributions and suggestions. If you'd like to contribute, please submit a PR of your changes with a link to the issue or feature request that your code addresses. Additionally, please follow the VS Code Coding Guidelines.
Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Legal Notices
Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the Creative Commons Attribution 4.0 International Public License, see the LICENSE file, and grant you a license to any code in the repository under the MIT License, see the LICENSE-CODE file.
Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found here.
Privacy information can be found here.
Microsoft and any contributors reserve all other rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise.