Skip to content

Commit 32d2a87

Browse files
committed
{feature} rename composed-css package
1 parent dbd7325 commit 32d2a87

18 files changed

+717
-48
lines changed

.eslintrc.yml

-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ rules:
3838
overrides:
3939
- files:
4040
- packages/test/src/harness/**/browser.js
41-
- packages/composed-css/src/**/*.js
4241
env:
4342
browser: true
4443
- files: ["**/*.ts"]

.prettierignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.yarn
22

33
/packages/*/dist
4-
/packages/composed-css/*.js
5-
/packages/composed-css/*.cjs
4+
/packages/composed-dom/*.js
5+
/packages/composed-dom/*.cjs

.yarn/versions/0cf4f50d.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
releases:
2+
composed-dom: major
3+
4+
declined:
5+
- "@ngx-playwright/test"

angular.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"build": {
1111
"builder": "@snuggery/snuggery:glob",
1212
"options": {
13-
"include": "@ngx-playwright/*"
13+
"include": ["@ngx-playwright/*", "composed-dom"]
1414
}
1515
},
1616
"deploy": {
@@ -99,8 +99,8 @@
9999
}
100100
}
101101
},
102-
"@ngx-playwright/composed-css": {
103-
"root": "packages/composed-css",
102+
"composed-dom": {
103+
"root": "packages/composed-dom",
104104
"architect": {
105105
"build": {
106106
"builder": "@snuggery/build-node:build",
@@ -120,7 +120,7 @@
120120
}
121121
],
122122
"package": true,
123-
"tsconfig": "packages/composed-css/tsconfig.lib.json"
123+
"tsconfig": "packages/composed-dom/tsconfig.lib.json"
124124
}
125125
}
126126
}

packages/composed-css/index.js

-1
This file was deleted.

packages/composed-dom/.gitattributes

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/index.js linguist-generated
2+
/selector-engine.cjs linguist-generated
File renamed without changes.

packages/composed-css/README.md packages/composed-dom/README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `@ngx-playwright/composed-css`
1+
# `composed-dom`
22

33
<!-- cspell:word shadowrootmode -->
44

@@ -86,6 +86,23 @@ import {selectors} from "@playwright/test";
8686

8787
await selectors.register(
8888
"css:composed",
89-
import.meta.resolve("@ngx-playwright/composed-css/selector-engine"),
89+
import.meta.resolve("composed-dom/selector-engine"),
9090
);
9191
```
92+
93+
## Usage in non-browser environments
94+
95+
The `composed-dom` package only references one browser-specific global: the `document`.
96+
The `document` is only used if no `container` is passed as second parameter.
97+
This makes it possible to use this package in environments other than a browser tab, as long as you're able to provide a valid DOM Document or Element as `container` parameter.
98+
99+
```js
100+
import {querySelector} from "composed-dom";
101+
import {JSDOM} from "jsdom";
102+
103+
const dom = new JSDOM(/* ... */);
104+
105+
// Pass in a container argument to make querySelector run in
106+
// this non-browser environment.
107+
const mainHeader = querySelector("h1", dom.window.document);
108+
```

0 commit comments

Comments
 (0)