Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 0 additions & 39 deletions api-goldens/charts-ng/index.api.md

This file was deleted.

20 changes: 1 addition & 19 deletions projects/charts-ng/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,7 @@ You also have to install the peer dependencies of Element Charts.
npm install echarts --save
```

Import the library to your Angular `AppModule`, mostly residing in your
`src/app/app.modules.ts` file as follows:

```ts
// [...]

// Import this library
import { SiChartsNgModule } from '@siemens/charts-ng';

@NgModule({
declarations: [AppComponent],
imports: [BrowserModule, SiChartsNgModule],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule {}
```

Starting with v49, Element Charts uses separate entry points for each component.
Element Charts uses separate entry points for each component.
Import components directly from their specific entry points:

```ts
Expand Down
48 changes: 0 additions & 48 deletions projects/charts-ng/public-api.module.ts

This file was deleted.

15 changes: 2 additions & 13 deletions projects/charts-ng/public-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,5 @@
* Copyright (c) Siemens 2016 - 2025
* SPDX-License-Identifier: MIT
*/

export * from '@siemens/charts-ng/cartesian';
export * from '@siemens/charts-ng/chart';
export * from '@siemens/charts-ng/circle';
export * from '@siemens/charts-ng/gauge';
export * from '@siemens/charts-ng/progress';
export * from '@siemens/charts-ng/progress-bar';
export * from '@siemens/charts-ng/common';
export * from '@siemens/charts-ng/custom-legend';
export * from '@siemens/charts-ng/loading-spinner';
export * from '@siemens/charts-ng/sankey';
export * from '@siemens/charts-ng/sunburst';
export * from './public-api.module';
/** */
export const NOTHING = 'nothing';
Comment on lines +5 to +6

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Exporting a NOTHING constant from the main entry point can be confusing for developers, as its purpose isn't immediately clear. To improve clarity, consider replacing this with a descriptive comment explaining that this entry point is intentionally empty and that developers should use the secondary entry points. If an export is strictly necessary for the build process, an explanatory comment should accompany it.

Suggested change
/** */
export const NOTHING = 'nothing';
/**
* The main entry point `@siemens/charts-ng` is intentionally left empty.
* Please use secondary entry points for individual components, for example:
* `import { SiChartCartesianComponent } from '@siemens/charts-ng/cartesian';`
*
* This approach promotes smaller bundle sizes by allowing you to import only what you need.
*/

Loading