Back to Ionic Framework

README

docs/README.md

8.8.53.4 KB
Original Source
<p align="center"> </p> <h1 align="center"> Ionic Framework Developer Resources </h1> <p align="center"> This documentation includes guidelines on contributing, coding conventions, best practices, testing steps, and more. It should serve as a collective resource for all documentation related to developing Ionic Framework. </p>

What is Ionic Framework?

Ionic Framework is an open source app development toolkit for building modern, fast, top-quality cross-platform native and Progressive Web Apps from a single codebase with JavaScript and the Web.

It is based on <a href="https://www.webcomponents.org/introduction">Web Components</a>, which enables significant performance, usability, and feature improvements alongside support for popular web frameworks like <a href="https://angular.io/">Angular</a>, <a href="https://reactjs.com/">React</a>, and <a href="https://vuejs.org/">Vue</a>.

Guides

GuideDescription
ContributingHow to contribute including creating pull requests, commit message guidelines, and more.
Component GuideGuidelines for implementing component states, accessibility, and more.
Sass GuidelinesOutlines scenarios where Sass members and comments should be used.
CSS Shadow Parts GuidelinesGuidelines for CSS shadow parts in components.

Packages

ProjectPackageDocumentationGuides
Core@ionic/coreReadmeTesting
Angular@ionic/angularReadmeTesting
React@ionic/reactReadmeTesting
React Router@ionic/react-routerReadmeTesting
Vue@ionic/vueReadmeTesting
Vue Router@ionic/vue-routerReadmeTesting