You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- This is the _only place_ where you can add files. So if you wanted to add a select component to the headless kit, you would add all your files to this directory:
82
+
- This is the _only place_ where you can add files. So if you wanted to add an example called 'hero' to the headless select component, that file needs to have the following structure:
- Remenber to follow the component test server's URL structure. The default message on the "home page" of the dev server is a reminder of how to use the address bar to actually view the file you want. By default it would have this structure:
88
+
- Remenber to follow the component test server's URL structure. The default message on the "home page" of the dev server is a reminder of how to use the address bar to view the file you want. By default it would have this structure:
89
89
90
90
```shell
91
-
http://localhost:5173/[KIT]/[COMPONENT]/[EXAMPLE]
91
+
http://localhost:5173/[KIT]/[COMPONENT]/[FILE]
92
92
```
93
93
94
94
- So if you wanted to see the hero example for the headless select you would go here:
95
95
96
96
```shell
97
-
http://localhost:5173/headless/select/hero/
97
+
http://localhost:5173/headless/select/hero
98
98
```
99
99
100
+
- TLDR: any file in 'apps/website/src/routes/docs/[KIT]/[COMPONENT]/examples/[FILE]' is served on '/[KIT]/[COMPONENT]/[FILE]'
101
+
100
102
Below is a list of other commands that you might find useful:
101
103
102
104
- Build the qwik-ui documentation:
@@ -125,13 +127,15 @@ pnpm preview.cloudflare
125
127
126
128
### 5. Make sure you add / modify tests
127
129
128
-
Run either command to make sure there aren't any errors.
130
+
Run either command to make sure there aren't any errors. Both commands run the Playwrigth tests, but the second one will open Playwrigth in [UI mode](https://playwright.dev/docs/test-ui-mode)
129
131
130
132
```shell
131
-
pnpm test.headless --skip-nx-cache
133
+
pnpm test.pw.headless --skip-nx-cache
132
134
```
133
135
134
-
This will set up the Cypress component testing GUI. Please refer to official Cypress [documentation](https://docs.cypress.io/guides/overview/why-cypress) for further assistance.
0 commit comments