mirror of https://github.com/abpframework/abp
maliming
4 years ago
commit
bc04fcba49
@ -0,0 +1,101 @@
|
||||
# Angular UI v4.x to v5.0 Migration Guide
|
||||
|
||||
## Breaking Changes
|
||||
|
||||
### Overall
|
||||
|
||||
See the overall list of breaking changes:
|
||||
|
||||
- Bootstrap 5 implementation [#10067](https://github.com/abpframework/abp/issues/10067)
|
||||
- Remove NGXS dependency & states [#9952](https://github.com/abpframework/abp/issues/9952)
|
||||
- Install @angular/localize package to startup templates [#10099](https://github.com/abpframework/abp/issues/10099)
|
||||
- Create new secondary entrypoints and move the related proxies to there [#10060](https://github.com/abpframework/abp/issues/10060)
|
||||
- Move SettingTabsService to @abp/ng.setting-management/config package from @abp/ng.core [#10061](https://github.com/abpframework/abp/issues/10061)
|
||||
- Make the @abp/ng.account dependent on @abp/ng.identity [#10059](https://github.com/abpframework/abp/issues/10059)
|
||||
- Set default abp-modal size medium [#10118](https://github.com/abpframework/abp/issues/10118)
|
||||
- Update all dependency versions to the latest [#9806](https://github.com/abpframework/abp/issues/9806)
|
||||
- Chart.js big include with CommonJS warning [#7472](https://github.com/abpframework/abp/issues/7472)
|
||||
|
||||
### Angular v12
|
||||
|
||||
The new ABP Angular UI is based on Angular v12. We started to compile Angular UI packages with the Ivy compilation. Therefore, **new packages only work with Angular v12**. If you are still on the older version of Angular v12, you have to update to Angular v12. The update is usually very easy. See [Angular Update Guide](https://update.angular.io/?l=2&v=11.0-12.0) for further information.
|
||||
|
||||
### Bootstrap 5
|
||||
|
||||
TODO
|
||||
|
||||
### NGXS has been removed
|
||||
|
||||
We aim to make the ABP Framework free of any state-management solutions. ABP developers should be able to use the ABP Framework with any library/framework of their choice. So, we decided to remove NGXS from ABP packages.
|
||||
|
||||
If you'd like to use NGXS after upgrading to v5.0, you have to install the NGXS to your project. The package can be installed with the following command:
|
||||
|
||||
```bash
|
||||
npm install @ngxs/store
|
||||
|
||||
# or
|
||||
|
||||
yarn add @ngxs/store
|
||||
```
|
||||
|
||||
NGXS states and actions, some namespaces have been removed. See [this issue](https://github.com/abpframework/abp/issues/9952) for the details.
|
||||
|
||||
If you don't want to use the NGXS, you should remove all NGXS related imports, injections, etc., from your project.
|
||||
|
||||
### @angular/localize package
|
||||
|
||||
[`@angular/localize`](https://angular.io/api/localize) dependency has been removed from `@abp/ng.core` package. The package must be installed in your app. Run the following command to install:
|
||||
|
||||
```bash
|
||||
npm install @angular/localize
|
||||
|
||||
# or
|
||||
|
||||
yarn add @angular/localize
|
||||
```
|
||||
|
||||
> ABP Angular UI packages are not dependent on the `@angular/localize` package. However, some packages (like `@ng-bootstrap/ng-bootstrap`) depend on the package. Thus, this package needs to be installed in your project.
|
||||
|
||||
### Proxy endpoints
|
||||
|
||||
New endpoints named proxy have been created, related proxies have moved.
|
||||
For example; before v5.0, `IdentityUserService` could be imported from `@abp/ng.identity`. As of v5.0, the service can be imported from `@abp/ng.identity/proxy`. See an example:
|
||||
|
||||
```ts
|
||||
import { IdentityUserService } from '@abp/ng.identity/proxy';
|
||||
|
||||
@Component({})
|
||||
export class YourComponent {
|
||||
constructor(private identityUserService: IdentityUserService) {}
|
||||
}
|
||||
```
|
||||
|
||||
Following proxies have been affected:
|
||||
|
||||
- `@abp/ng.account` to `@abp/ng.account.core/proxy`
|
||||
- `@abp/ng.feature-management` to `@abp/ng.feature-management/proxy`
|
||||
- `@abp/ng.identity` to `@abp/ng.identity/proxy`
|
||||
- `@abp/ng.permission-management` to `@abp/ng.permission-management/proxy`
|
||||
- `@abp/ng.tenant-management` to `@abp/ng.tenant-management/proxy`
|
||||
- **ProfileService** is deleted from `@abp/ng.core`. Instead, you can import it from `@abp/ng.identity/proxy`
|
||||
|
||||
### SettingTabsService
|
||||
|
||||
**SettingTabsService** has moved from `@abp/ng.core` to `@abp/ng.setting-management/config`.
|
||||
|
||||
### ChartComponent
|
||||
|
||||
`ChartComponent` has moved from `@abp/ng.theme.shared` to `@abp/ng.components/chart.js`. To use the component, you need to import the `ChartModule` to your module as follows:
|
||||
|
||||
```ts
|
||||
import { ChartModule } from '@abp/ng.components/chart.js';
|
||||
|
||||
@NgModule({
|
||||
imports: [
|
||||
ChartModule,
|
||||
// ...
|
||||
],
|
||||
// ...
|
||||
})
|
||||
export class YourFeatureModule {}
|
||||
```
|
||||
@ -0,0 +1,42 @@
|
||||
# ABP Framework v4.x to v5.0 Migration Guide
|
||||
|
||||
## IdentityUser
|
||||
|
||||
We added an `IsActive(bool)` property to `IdentityUser` to [control whether it is available](https://github.com/abpframework/abp/pull/10185). **Please set it to `true` of the old user after the upgrade.**
|
||||
|
||||
For EF Core you can change `defaultValue` to `true` in the migration class:
|
||||
```cs
|
||||
public partial class AddIsActiveToIdentityUser : Migration
|
||||
{
|
||||
protected override void Up(MigrationBuilder migrationBuilder)
|
||||
{
|
||||
migrationBuilder.AddColumn<bool>(
|
||||
name: "IsActive",
|
||||
table: "AbpUsers",
|
||||
type: "bit",
|
||||
nullable: false,
|
||||
defaultValue: true); // Default is false.
|
||||
}
|
||||
|
||||
protected override void Down(MigrationBuilder migrationBuilder)
|
||||
{
|
||||
migrationBuilder.DropColumn(
|
||||
name: "IsActive",
|
||||
table: "AbpUsers");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## MongoDB
|
||||
|
||||
ABP Framework will serialize the datetime based on [AbpClockOptions](https://docs.abp.io/en/abp/latest/Timing#clock-options) start from 5.0, before `DateTime` values in MongoDB are [always saved as UTC](https://mongodb.github.io/mongo-csharp-driver/2.13/reference/bson/mapping/#datetime-serialization-options).
|
||||
|
||||
You can disable this behavior by configure `AbpMongoDbOptions`.
|
||||
```cs
|
||||
services.Configure<AbpMongoDbOptions>(x => x.UseAbpClockHandleDateTime = false);
|
||||
```
|
||||
|
||||
## Angular UI
|
||||
|
||||
See the [Angular UI Migration Guide](Abp-5_0-Angular.md).
|
||||
@ -1,7 +1,7 @@
|
||||
# ABP Framework Migration Guides
|
||||
|
||||
* [4.2 to 4.3](Abp-4_3.md)
|
||||
* [4.x to 4.2](Abp-4_2.md)
|
||||
* [3.3.x to 4.0](Abp-4_0.md)
|
||||
* [2.9.x to 3.0](../UI/Angular/Migration-Guide-v3.md)
|
||||
|
||||
- [4.x to 5.0](Abp-5_0.md)
|
||||
- [4.2 to 4.3](Abp-4_3.md)
|
||||
- [4.x to 4.2](Abp-4_2.md)
|
||||
- [3.3.x to 4.0](Abp-4_0.md)
|
||||
- [2.9.x to 3.0](../UI/Angular/Migration-Guide-v3.md)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue