mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-06 14:41:31 +08:00
docs(readme): update broken links, repository name, clean up readme (#29508)
This commit is contained in:
Brandy Carney
22
README.md
22
README.md
@ -20,7 +20,7 @@
|
||||
<a href="https://github.com/ionic-team/ionic-framework/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Ionic Framework is released under the MIT license." />
|
||||
</a>
|
||||
<a href="https://github.com/ionic-team/ionic/blob/main/docs/CONTRIBUTING.md">
|
||||
<a href="https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md">
|
||||
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />
|
||||
</a>
|
||||
<a href="https://twitter.com/Ionicframework">
|
||||
@ -38,7 +38,7 @@
|
||||
Documentation
|
||||
</a>
|
||||
<span> · </span>
|
||||
<a href="https://github.com/ionic-team/ionic/blob/main/docs/CONTRIBUTING.md">Contribute</a>
|
||||
<a href="https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md">Contribute</a>
|
||||
<span> · </span>
|
||||
<a href="https://blog.ionicframework.com/">Blog</a>
|
||||
<br />
|
||||
@ -63,14 +63,15 @@ Looking for the `ionic-angular` package? Ionic 3 has been moved to the [`ionic-v
|
||||
|
||||
### Getting Started
|
||||
|
||||
Start a new project by following our quick [Getting Started guide](https://ionicframework.com/getting-started/).
|
||||
Start a new project by following our [documentation](https://ionicframework.com/docs/).
|
||||
We would love to hear from you! If you have any feedback or run into issues using our framework, please file
|
||||
an [issue](https://github.com/ionic-team/ionic/issues/new) on this repository.
|
||||
an [issue](https://github.com/ionic-team/ionic-framework/issues/new) on this repository.
|
||||
|
||||
### Migration Guides
|
||||
|
||||
Already have an Ionic app? These guides will help you migrate to the latest versions.
|
||||
|
||||
* [Migrate from v7 to v8](https://ionicframework.com/docs/updating/8-0)
|
||||
* [Migrate from v6 to v7](https://ionicframework.com/docs/updating/7-0)
|
||||
* [Migrate from v5 to v6](https://ionicframework.com/docs/updating/6-0)
|
||||
* [Migrate from v4 to v5](https://ionicframework.com/docs/updating/5-0)
|
||||
@ -82,21 +83,16 @@ The Ionic Conference App is a full featured Ionic app. It is the perfect startin
|
||||
|
||||
- [Angular Ionic Conference App](https://github.com/ionic-team/ionic-conference-app)
|
||||
- [React Ionic Conference App](https://github.com/ionic-team/ionic-react-conference-app)
|
||||
<!-- TODO(FW-3811): add this when the vue conference app is updated -->
|
||||
<!-- - [Vue Ionic Conference App](https://github.com/ionic-team/ionic-vue-conference-app) -->
|
||||
- [Vue Ionic Conference App](https://github.com/ionic-team/ionic-vue-conference-app)
|
||||
|
||||
### Contributing
|
||||
|
||||
Thanks for your interest in contributing! Read up on our guidelines for
|
||||
[contributing](https://github.com/ionic-team/ionic/blob/main/docs/CONTRIBUTING.md)
|
||||
and then look through our issues with a [help wanted](https://github.com/ionic-team/ionic/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
|
||||
[contributing](https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md)
|
||||
and then look through our issues with a [help wanted](https://github.com/ionic-team/ionic-framework/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
|
||||
label.
|
||||
|
||||
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/ionic-team/ionic/blob/main/CODE_OF_CONDUCT.md). 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.
|
||||
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/ionic-team/ionic-framework/blob/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
|
||||
|
||||
### Earlier Versions
|
||||
|
||||
|
||||
@ -108,7 +108,7 @@
|
||||
"url": "git+https://github.com/ionic-team/ionic-framework.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/ionic-team/ionic/issues"
|
||||
"url": "https://github.com/ionic-team/ionic-framework/issues"
|
||||
},
|
||||
"homepage": "https://ionicframework.com/",
|
||||
"jest": {
|
||||
|
||||
@ -363,7 +363,7 @@ export class Searchbar implements ComponentInterface {
|
||||
this.ionClear.emit();
|
||||
|
||||
return new Promise<void>((resolve) => {
|
||||
// setTimeout() fixes https://github.com/ionic-team/ionic/issues/7527
|
||||
// setTimeout() fixes https://github.com/ionic-team/ionic-framework/issues/7527
|
||||
// wait for 4 frames
|
||||
setTimeout(() => {
|
||||
const value = this.getValue();
|
||||
|
||||
@ -46,7 +46,7 @@
|
||||
|
||||
.toggle-icon {
|
||||
// Needed to prevent visual glitch in safari/iOS
|
||||
// See https://github.com/ionic-team/ionic/issues/14626
|
||||
// See https://github.com/ionic-team/ionic-framework/issues/14626
|
||||
transform: translate3d(0, 0, 0);
|
||||
|
||||
transition: background-color $toggle-ios-transition-duration;
|
||||
|
||||
@ -213,7 +213,7 @@ export const config: Config = {
|
||||
{
|
||||
type: 'docs-vscode',
|
||||
file: 'dist/html.html-data.json',
|
||||
sourceCodeBaseUrl: 'https://github.com/ionic-team/ionic/tree/main/core/',
|
||||
sourceCodeBaseUrl: 'https://github.com/ionic-team/ionic-framework/tree/main/core/',
|
||||
},
|
||||
{
|
||||
type: 'dist',
|
||||
|
||||
@ -384,9 +384,9 @@ ion-ripple-effect {
|
||||
|
||||
### Example Components
|
||||
|
||||
- [ion-button](https://github.com/ionic-team/ionic/tree/main/core/src/components/button)
|
||||
- [ion-back-button](https://github.com/ionic-team/ionic/tree/main/core/src/components/back-button)
|
||||
- [ion-menu-button](https://github.com/ionic-team/ionic/tree/main/core/src/components/menu-button)
|
||||
- [ion-button](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/button)
|
||||
- [ion-back-button](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/back-button)
|
||||
- [ion-menu-button](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/menu-button)
|
||||
|
||||
### References
|
||||
|
||||
@ -400,7 +400,7 @@ ion-ripple-effect {
|
||||
|
||||
#### Example Components
|
||||
|
||||
- [ion-checkbox](https://github.com/ionic-team/ionic/tree/main/core/src/components/checkbox)
|
||||
- [ion-checkbox](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/checkbox)
|
||||
|
||||
#### VoiceOver
|
||||
|
||||
@ -479,7 +479,7 @@ render() {
|
||||
<Host>
|
||||
<label>
|
||||
{this.labelText}
|
||||
<input type="checkbox" {...this.inheritedAttributes} />
|
||||
<input type="checkbox" {...this.inheritedAttributes} />
|
||||
</label>
|
||||
</Host>
|
||||
)
|
||||
@ -511,7 +511,7 @@ This is a compromise we have to make in order for it to work with the other scre
|
||||
|
||||
#### Example Components
|
||||
|
||||
- [ion-toggle](https://github.com/ionic-team/ionic/tree/main/core/src/components/toggle)
|
||||
- [ion-toggle](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/toggle)
|
||||
|
||||
#### Voiceover
|
||||
|
||||
@ -592,7 +592,7 @@ render() {
|
||||
<Host>
|
||||
<label>
|
||||
{this.labelText}
|
||||
<input type="checkbox" role="switch" {...this.inheritedAttributes} />
|
||||
<input type="checkbox" role="switch" {...this.inheritedAttributes} />
|
||||
</label>
|
||||
</Host>
|
||||
)
|
||||
@ -624,8 +624,8 @@ There is a WebKit bug open for this: https://bugs.webkit.org/show_bug.cgi?id=196
|
||||
|
||||
#### Example Components
|
||||
|
||||
- [ion-accordion](https://github.com/ionic-team/ionic/tree/master/core/src/components/accordion)
|
||||
- [ion-accordion-group](https://github.com/ionic-team/ionic/tree/master/core/src/components/accordion-group)
|
||||
- [ion-accordion](https://github.com/ionic-team/ionic-framework/tree/master/core/src/components/accordion)
|
||||
- [ion-accordion-group](https://github.com/ionic-team/ionic-framework/tree/master/core/src/components/accordion-group)
|
||||
|
||||
#### NVDA
|
||||
|
||||
@ -640,11 +640,11 @@ Certain components can render an `<a>` or a `<button>` depending on the presence
|
||||
|
||||
### Example Components
|
||||
|
||||
- [ion-button](https://github.com/ionic-team/ionic/tree/main/core/src/components/button)
|
||||
- [ion-card](https://github.com/ionic-team/ionic/tree/main/core/src/components/card)
|
||||
- [ion-fab-button](https://github.com/ionic-team/ionic/tree/main/core/src/components/fab-button)
|
||||
- [ion-item-option](https://github.com/ionic-team/ionic/tree/main/core/src/components/item-option)
|
||||
- [ion-item](https://github.com/ionic-team/ionic/tree/main/core/src/components/item)
|
||||
- [ion-button](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/button)
|
||||
- [ion-card](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/card)
|
||||
- [ion-fab-button](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/fab-button)
|
||||
- [ion-item-option](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/item-option)
|
||||
- [ion-item](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/item)
|
||||
|
||||
### Component Structure
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
"url": "git+https://github.com/ionic-team/ionic-framework.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/ionic-team/ionic/issues"
|
||||
"url": "https://github.com/ionic-team/ionic-framework/issues"
|
||||
},
|
||||
"publishConfig": {
|
||||
"directory": "dist"
|
||||
|
||||
@ -20,7 +20,7 @@
|
||||
"url": "git+https://github.com/ionic-team/ionic-framework.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/ionic-team/ionic/issues"
|
||||
"url": "https://github.com/ionic-team/ionic-framework/issues"
|
||||
},
|
||||
"homepage": "https://ionicframework.com/",
|
||||
"scripts": {
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
const port = 3000;
|
||||
/*
|
||||
This spec covers that routes can be added and navigated to at runtime.
|
||||
Fixes bug reported in https://github.com/ionic-team/ionic/issues/21329
|
||||
Fixes bug reported in https://github.com/ionic-team/ionic-framework/issues/21329
|
||||
*/
|
||||
|
||||
describe('Dynamic Routes', () => {
|
||||
|
||||
@ -3,7 +3,7 @@ const port = 3000;
|
||||
describe('Dynamic Tabs', () => {
|
||||
/*
|
||||
This spec tests being able to add a tab at runtime and to be able to go to it
|
||||
Fixes bug https://github.com/ionic-team/ionic/issues/21112
|
||||
Fixes bug https://github.com/ionic-team/ionic-framework/issues/21112
|
||||
*/
|
||||
|
||||
it('/dynamic-tabs > Tab 1 should be visible', () => {
|
||||
|
||||
@ -3,7 +3,7 @@ const port = 3000;
|
||||
describe('Multiple Tabs', () => {
|
||||
/*
|
||||
This spec tests that switching between tabs via a menu works
|
||||
Fixes bug https://github.com/ionic-team/ionic/issues/21336
|
||||
Fixes bug https://github.com/ionic-team/ionic-framework/issues/21336
|
||||
*/
|
||||
|
||||
it('/multiple-tabs > PageA should be visible', () => {
|
||||
|
||||
@ -6,7 +6,7 @@ describe('Nested Outlets', () => {
|
||||
and to be able to transition to/from one nested outlet.
|
||||
Utilizes `ionPage` prop on `IonRouterOutlet` to make the router outlet
|
||||
a target of the transition.
|
||||
Fixes bug https://github.com/ionic-team/ionic/issues/20597
|
||||
Fixes bug https://github.com/ionic-team/ionic-framework/issues/20597
|
||||
*/
|
||||
|
||||
it('/nested-outlet > First Page should be visible', () => {
|
||||
@ -59,7 +59,7 @@ describe('Nested Outlets 2', () => {
|
||||
outlet is transition from and to itself, therefore it can't animate.
|
||||
I think the same issue exists when going from a item page back to the list page.
|
||||
This should be fixable through configuring a less complicated route structure in the app.
|
||||
Fixes bug https://github.com/ionic-team/ionic/issues/20219
|
||||
Fixes bug https://github.com/ionic-team/ionic-framework/issues/20219
|
||||
*/
|
||||
|
||||
it('/nested-outlet2 > First Page should be visible', () => {
|
||||
|
||||
@ -228,7 +228,7 @@ describe('Routing Tests', () => {
|
||||
});
|
||||
|
||||
it('/ > Details 1 on settings > Back > Settings Tab, should be on setting home', () => {
|
||||
// For bug https://github.com/ionic-team/ionic/issues/21031
|
||||
// For bug https://github.com/ionic-team/ionic-framework/issues/21031
|
||||
cy.visit(`http://localhost:${port}/routing/`);
|
||||
cy.ionNav('ion-item', 'Details 1 on settings');
|
||||
cy.ionPageVisible('settings-details-page-1');
|
||||
|
||||
@ -40,9 +40,9 @@
|
||||
"author": "",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/ionic-team/ionic/issues"
|
||||
"url": "https://github.com/ionic-team/ionic-framework/issues"
|
||||
},
|
||||
"homepage": "https://github.com/ionic-team/ionic#readme",
|
||||
"homepage": "https://github.com/ionic-team/ionic-framework#readme",
|
||||
"dependencies": {
|
||||
"@ionic/vue": "^8.1.2"
|
||||
},
|
||||
|
||||
@ -45,9 +45,9 @@
|
||||
"author": "",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/ionic-team/ionic/issues"
|
||||
"url": "https://github.com/ionic-team/ionic-framework/issues"
|
||||
},
|
||||
"homepage": "https://github.com/ionic-team/ionic#readme",
|
||||
"homepage": "https://github.com/ionic-team/ionic-framework#readme",
|
||||
"devDependencies": {
|
||||
"@babel/types": "^7.18.4",
|
||||
"@ionic/eslint-config": "^0.3.0",
|
||||
|
||||
Reference in New Issue
Block a user