Skip to content
Merged
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
3 changes: 2 additions & 1 deletion apps/solace-message-client-testing-app/src/app/app.config.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {ApplicationConfig, EnvironmentProviders, makeEnvironmentProviders} from '@angular/core';
import {ApplicationConfig, EnvironmentProviders, makeEnvironmentProviders, provideZoneChangeDetection} from '@angular/core';
import {provideRouter, withHashLocation} from '@angular/router';
import {routes} from './app.routes';
import {MAT_FORM_FIELD_DEFAULT_OPTIONS} from '@angular/material/form-field';
Expand All @@ -10,8 +10,9 @@
export const appConfig: ApplicationConfig = {
providers: [
provideRouter(routes, withHashLocation()),
provideAnimations(),

Check warning on line 13 in apps/solace-message-client-testing-app/src/app/app.config.ts

View workflow job for this annotation

GitHub Actions / Linting

`provideAnimations` is deprecated. 20.2 Use `animate.enter` or `animate.leave` instead. Intent to remove in v23

Check warning on line 13 in apps/solace-message-client-testing-app/src/app/app.config.ts

View workflow job for this annotation

GitHub Actions / Linting

`provideAnimations` is deprecated. 20.2 Use `animate.enter` or `animate.leave` instead. Intent to remove in v23
provideMaterialDefaults(),
provideZoneChangeDetection(),
],
};

Expand Down
15 changes: 11 additions & 4 deletions docs/site/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@

This short manual explains how to install and use the library.

> [!WARNING]
> `@solace-community/angular-solace-message-client` does not support zoneless mode and may not work as expected. Support is planned for 2026.

<details>
<summary><strong>Step 1: Install the Library from NPM</strong></summary>
<br>
Expand All @@ -26,7 +29,7 @@ npm install @solace-community/angular-solace-message-client solclientjs @scion/t
Open `app.config.ts` and register Solace Message Client providers.

```ts
import {ApplicationConfig} from '@angular/core';
import {ApplicationConfig, provideZoneChangeDetection} from '@angular/core';
import {provideSolaceMessageClient} from '@solace-community/angular-solace-message-client';

export const appConfig: ApplicationConfig = {
Expand All @@ -36,7 +39,8 @@ export const appConfig: ApplicationConfig = {
vpnName: 'YOUR VPN',
userName: 'YOUR USERNAME',
password: 'YOUR PASSWORD',
})
}),
provideZoneChangeDetection(), // provide zone change detection until `@solace-community/angular-solace-message-client` supports zoneless
],
};
```
Expand All @@ -46,6 +50,7 @@ If you are not using `app.config.ts`, register the Solace Message Client directl
```ts
import {bootstrapApplication} from '@angular/platform-browser';
import {provideSolaceMessageClient} from '@solace-community/angular-solace-message-client';
import {provideZoneChangeDetection} from '@angular/core';

bootstrapApplication(AppComponent, {
providers: [
Expand All @@ -54,7 +59,8 @@ bootstrapApplication(AppComponent, {
vpnName: 'YOUR VPN',
userName: 'YOUR USERNAME',
password: 'YOUR PASSWORD',
})
}),
provideZoneChangeDetection(), // provide zone change detection until `@solace-community/angular-solace-message-client` supports zoneless
],
});
```
Expand All @@ -63,7 +69,7 @@ Or for `NgModule` based applications:

```ts
import {provideSolaceMessageClient} from '@solace-community/angular-solace-message-client';
import {NgModule} from '@angular/core';
import {NgModule, provideZoneChangeDetection} from '@angular/core';

@NgModule({
providers: [
Expand All @@ -73,6 +79,7 @@ import {NgModule} from '@angular/core';
userName: 'YOUR USERNAME',
password: 'YOUR PASSWORD',
}),
provideZoneChangeDetection(), // provide zone change detection until `@solace-community/angular-solace-message-client` supports zoneless
],
bootstrap: [
AppComponent,
Expand Down
2 changes: 1 addition & 1 deletion eslint.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ module.exports = tseslint.config(
},
tseslint.configs.stylisticTypeChecked,
angular.configs.tsRecommended, // https://github.com/angular-eslint/angular-eslint/blob/main/packages/angular-eslint/src/configs/README.md
stylistic.configs['recommended-flat'], // https://eslint.style/guide/config-presets#static-configurations
stylistic.configs['recommended'], // https://eslint.style/guide/config-presets#static-configurations
rxjs.configs.recommended, // https://github.com/DaveMBush/eslint-plugin-rxjs?tab=readme-ov-file#rules
],
processor: angular.processInlineTemplates, // https://github.com/angular-eslint/angular-eslint/blob/main/docs/CONFIGURING_FLAT_CONFIG.md#notes-on-eslint-configuration
Expand Down
Loading