Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Angular: add info about standalone and directives (#6970) #6974

Merged
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
To change attributes of all components of one type in an app, use [defaultOptions](/Documentation/ApiReference/UI_Components/dxTextBox/Methods/#defaultOptionsrule). To change attributes of multiple components, use directives.

When working with [custom directives](https://angular.dev/guide/directives/attribute-directives), follow these steps:

1. Import required components in the `.directive.ts` file. For example, `import { DxButtonComponent } from 'devextreme-angular';`.
2. Define the components in the constructor. Use the [`@Host`](https://angular.dev/api/core/Host?tab=usage-notes) decorator to access the instance of hosting components. Use the [`@Optional`](https://angular.dev/api/core/Optional?tab=usage-notes) decorator when specifying multiple components.
3. Use the `ngOnViewInit()` hook to ensure component initialization.

The following code snippet creates a directive that changes the style and switches "apple" to "banana" in the TextArea and TextBox components:

<!-- tab: replace.directive.ts -->
import { Directive, Host, Optional } from '@angular/core';
import { DxTextBoxComponent, DxTextAreaComponent } from 'devextreme-angular';
import { DxTextAreaTypes } from 'devextreme-angular/ui/text-area';
import { DxTextBoxTypes } from 'devextreme-angular/ui/text-box';

@Directive({
selector: '[appReplace]',
standalone: true,
})
export class ReplaceDirective {
component: any;

constructor(
@Optional() @Host() textBox: DxTextBoxComponent,
@Optional() @Host() textArea: DxTextAreaComponent
) {
this.component = textBox || textArea;
}

replaceApple(e: DxTextAreaTypes.FocusOutEvent & DxTextBoxTypes.FocusOutEvent) {
const value = e.component.option('value');
e.component.option('value', value?.replace(/apple/g, 'banana'));
}

ngAfterViewInit() {
this.component.instance.option('stylingMode', 'filled');
this.component.instance.on('focusOut', this.replaceApple);
}

ngOnDestroy() {
this.component.instance.off('focusOut', this.replaceApple);
}
}

<!-- tab: app.component.ts -->
import { Component } from '@angular/core';
import { DxTextBoxModule, DxTextAreaModule } from 'devextreme-angular';
import { ReplaceDirective } from './replace.directive';

@Component({
selector: 'app-root',
standalone: true,
imports: [DxTextBoxModule, DxTextAreaModule, ReplaceDirective],
templateUrl: './app.component.html',
styleUrl: './app.component.css'
})
export class AppComponent { }

<!-- tab: app.component.html -->
<dx-text-area appReplace></dx-text-area>
<dx-text-box appReplace></dx-text-box>
25 changes: 17 additions & 8 deletions includes/ng-import-devextreme-modules.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,19 @@
Go to the `NgModule` in which you are going to use DevExtreme UI components and import the required DevExtreme modules. Note that if [tree shaking](/concepts/40%20Angular%20Components/40%20Common%20Features/10%20Tree%20Shaking.md '/Documentation/Guide/Angular_Components/Common_Features/Tree_Shaking/') is configured in your application, you can import the modules from `devextreme-angular`. Otherwise, you should import them from specific files.
If you use [standalone](https://angular.dev/guide/components) components, import the modules as shown below:

<!-- tab: app.component.ts -->
import { Component } from '@angular/core';
import { DxButtonModule } from 'devextreme-angular';

@Component({
selector: 'app-root',
standalone: true,
imports: [DxButtonModule],
templateUrl: './app.component.html',
styleUrl: './app.component.css'
})
export class AppComponent { }

If you use `NgModule`, import the DevExtreme modules as demonstrated in the following code snippet. If [tree shaking](/concepts/40%20Angular%20Components/40%20Common%20Features/10%20Tree%20Shaking.md '/Documentation/Guide/Angular_Components/Common_Features/Tree_Shaking/') is configured in your application, import the modules from `devextreme-angular`. If not, import them from files.

<!-- tab: app.module.ts -->
// ...
Expand All @@ -24,13 +39,7 @@ Now you can use the DevExtreme UI component in your application:
</dx-button>

<!-- tab: app.component.ts -->
import { Component } from '@angular/core';

@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
// ...
export class AppComponent {
helloWorld() {
alert('Hello world!');
Expand Down
Loading