Skip to content

docs(angular): document importOverrides #1542

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.

Sign up for GitHub

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

Open
timdeschryver wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(angular): document importOverrides #1542

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 18 additions & 2 deletions docs/angular-testing-library/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,9 +252,25 @@ await render(AppComponent, {
})
```

### `componentImports`
### `importOverrides`

A collection of imports to override a standalone component's imports with.
A collection of import overrides to replace specific imports of a standalone component without replacing the entire imports array. Each entry specifies which import to `replace` and what to replace it `with`. This is the preferred alternative to `componentImports` when you only want to stub a subset of a component's imports.

**default** : `undefined`

**example**:

```typescript
await render(AppComponent, {
importOverrides: [
{ replace: ChildComponent, with: MockChildComponent },
],
})
```

### ~~`componentImports`~~ (deprecated)

A collection of imports to override **all** of a standalone component's imports with. Prefer [`importOverrides`](#importOverrides) when you only need to replace specific imports.

**default** : `undefined`

Expand Down