Alice 2a9fed64e9 chore(item): modify slot deprecation notice to avoid JSDoc formatting issue (#26564)
This changes the deprecation notice for a few `@slot` tags on the
`ion-item` component. Previously the lines in question looked something
like this:

```ts
/**
 * @slot a slot that does something @deprecated this is going away!
 */
export class Item { ...
```

The intention behind formatting the JSDoc this way was to mark the
`@slot` itself as deprecated, to advice users that it will be removed in
the future.

Unfortunately, JSDoc tooling doesn't interpret the `@deprecated` tag as
referring to the `@slot` tag here, but instead as one of the tags
applied to the `Item` class. If we wanted to use `@deprecated` to mark
only a slot as deprecated then we'd need a way to write a JSDoc just for
that slot itself.

Since we don't want to mark the whole class as deprecated, as a
workaround, we can change to using `**DEPRECATED**` instead, which will
appear prominently in generated documentation but will not confuse tools
which are JSDoc-aware.
2023-01-04 12:05:32 -05:00
2022-12-14 14:37:39 +00:00
2015-11-13 21:11:21 -06:00
2022-12-14 14:37:39 +00:00
2022-12-14 14:37:39 +00:00
2022-10-05 13:53:03 +00:00

Ionic

Ionic

Ionic 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.

Ionic is based on Web Components, which enables significant performance, usability, and feature improvements alongside support for popular web frameworks like Angular, React, and Vue.

Ionic Framework is released under the MIT license. PRs welcome! Follow @IonicFramework Official Ionic Discord

Quickstart · Documentation · Contribute · Blog
Community: Discord · Forums · Twitter

Packages

Project Package Version Downloads Links
Core @ionic/core version NPM Downloads README.md
Angular @ionic/angular version NPM Downloads README.md
Vue @ionic/vue version NPM Downloads README.md
React @ionic/react version NPM Downloads README.md

Looking for the ionic-angular package? Ionic 3 has been moved to the ionic-v3 repo. See Earlier Versions.

Getting Started

Start a new project by following our quick Getting Started guide. We would love to hear from you! If you have any feedback or run into issues using our framework, please file an issue on this repository.

Migration Guides

Already have an Ionic app? These guides will help you migrate to the latest versions.

Examples

The Ionic Conference App is a full featured Ionic app. It is the perfect starting point for learning and building your own app.

Contributing

Thanks for your interest in contributing! Read up on our guidelines for contributing and then look through our issues with a help wanted label.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Future Goals

As Ionic Framework components migrate to the web component standard, a goal of ours is to have Ionic Framework easily work within all of the popular frameworks.

Earlier Versions

The source code for earlier versions of the Ionic Framework may exist in other repositories. Please open issues and pull requests in their respective repositories.

Description
A powerful cross-platform UI toolkit for building native-quality iOS, Android, and Progressive Web Apps with HTML, CSS, and JavaScript.
Readme MIT 2.4 GiB
Languages
TypeScript 60.5%
HTML 25.2%
SCSS 10.8%
JavaScript 2%
Vue 1%
Other 0.5%