@lynx-js/lynx-stack-docs-canary 0.0.2-canary-20261016-00fbd033 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1,12 @@
1
- []
1
+ [
2
+ {
3
+ "type": "file",
4
+ "name": "functions/createGetTemplateName",
5
+ "label": "createGetTemplateName"
6
+ },
7
+ {
8
+ "type": "file",
9
+ "name": "functions/createLynx",
10
+ "label": "createLynx"
11
+ }
12
+ ]
@@ -0,0 +1,14 @@
1
+ # Function: createGetTemplateName()
2
+
3
+ > **createGetTemplateName**(`fixedTool`: `Tool` \| `undefined`, `tool?`: `Tool` \| `undefined`): (`argv`: `Argv`) => `Promise`\<`string`\>
4
+
5
+ ## Parameters
6
+
7
+ | Parameter | Type | Default value |
8
+ | ------ | ------ | ------ |
9
+ | `fixedTool` | `Tool` \| `undefined` | `undefined` |
10
+ | `tool` | `Tool` \| `undefined` | `fixedTool` |
11
+
12
+ ## Returns
13
+
14
+ (`argv`: `Argv`) => `Promise`\<`string`\>
@@ -0,0 +1,15 @@
1
+ # Function: createLynx()
2
+
3
+ > **createLynx**(`options?`: [`CreateLynxOptions`](../interfaces/CreateLynxOptions.mdx)): `Promise`\<`void`\>
4
+
5
+ Scaffold a Lynx project.
6
+
7
+ ## Parameters
8
+
9
+ | Parameter | Type |
10
+ | ------ | ------ |
11
+ | `options` | [`CreateLynxOptions`](../interfaces/CreateLynxOptions.mdx) |
12
+
13
+ ## Returns
14
+
15
+ `Promise`\<`void`\>
@@ -1,3 +1,55 @@
1
- # Module: @lynx-js/create-lynx
1
+ # @lynx-js/create-lynx
2
2
 
3
3
  [npm](https://www.npmjs.com/package/@lynx-js/create-lynx) · [Source](https://github.com/lynx-family/lynx-stack/tree/main/packages/rspeedy/create-lynx) · [Changelog](https://github.com/lynx-family/lynx-stack/blob/main/packages/rspeedy/create-lynx/CHANGELOG.md)
4
+
5
+ Create a [Lynx](https://lynxjs.org/) app or library with one command.
6
+
7
+ ```bash
8
+ npm create @lynx-js/lynx@latest
9
+ ```
10
+
11
+ ## Templates
12
+
13
+ Templates are named `<build tool>-<DSL>-<language>`. Parts that are left out
14
+ take their default, so `rsbuild`, `rsbuild-ts` and `rsbuild-react-ts` all name
15
+ the same template.
16
+
17
+ | Template | Creates | Build tool | Config |
18
+ | --------------------------------------- | ------- | ------------------------------------------------ | ------------------ |
19
+ | `rsbuild-react-ts` / `rsbuild-react-js` | App | [Rsbuild](https://rsbuild.rs/) with `pluginLynx` | `rsbuild.config.*` |
20
+ | `rspeedy-react-ts` / `rspeedy-react-js` | App | [Rspeedy](https://lynxjs.org/rspeedy/) | `lynx.config.*` |
21
+ | `rslib-react-ts` / `rslib-react-js` | Library | [Rslib](https://rslib.rs/) | `rslib.config.*` |
22
+
23
+ Every template comes with [Rstest](https://rstest.rs/) and
24
+ `@lynx-js/react/testing-library` set up; run the tests with `npm run test`.
25
+
26
+ A library keeps JSX in its output (`dist/*.jsx`), so the Lynx app that depends
27
+ on it compiles the components with its own ReactLynx version. Pick the
28
+ `external-bundle` tool to also pack it into a Lynx External Bundle
29
+ (`dist-external-bundle/*.lynx.bundle`) that a host app loads at runtime.
30
+
31
+ ```bash
32
+ npm create @lynx-js/lynx@latest my-app -- --template rsbuild-react-ts
33
+ npm create @lynx-js/lynx@latest my-lib -- --template rslib-react-ts
34
+ ```
35
+
36
+ ## Options
37
+
38
+ | Option | Description |
39
+ | ---------------- | -------------------------------------------------------------------------------------- |
40
+ | `-d, --dir` | Directory to create the project in |
41
+ | `-t, --template` | Template to use |
42
+ | `--tools` | Extra tools, such as `eslint`, `prettier`, `biome`, or `external-bundle` for a library |
43
+ | `--skill` | Agent skills to install |
44
+ | `--override` | Override files in the target directory |
45
+
46
+ This package supersedes `create-rspeedy`.
47
+
48
+ ## Interfaces
49
+
50
+ - [CreateLynxOptions](interfaces/CreateLynxOptions.mdx)
51
+
52
+ ## Functions
53
+
54
+ - [createGetTemplateName](functions/createGetTemplateName.mdx)
55
+ - [createLynx](functions/createLynx.mdx)
@@ -0,0 +1,25 @@
1
+ # Interface: CreateLynxOptions
2
+
3
+ Options of [createLynx](../functions/createLynx.mdx).
4
+
5
+ ## Properties
6
+
7
+ ### name?
8
+
9
+ > `optional` **name?**: `string`
10
+
11
+ The name the CLI introduces itself with.
12
+
13
+ #### Default Value
14
+
15
+ ```ts
16
+ 'lynx'
17
+ ```
18
+
19
+ ***
20
+
21
+ ### tool?
22
+
23
+ > `optional` **tool?**: `Tool`
24
+
25
+ Build the project with this tool instead of asking for one.
@@ -1,3 +1,60 @@
1
1
  # @lynx-js/web-elements
2
2
 
3
3
  [npm](https://www.npmjs.com/package/@lynx-js/web-elements) · [Source](https://github.com/lynx-family/lynx-stack/tree/main/packages/web-platform/web-elements) · [Changelog](https://github.com/lynx-family/lynx-stack/blob/main/packages/web-platform/web-elements/CHANGELOG.md)
4
+
5
+
6
+ It provides the custom-element implementation of Lynx Elements in Web.
7
+
8
+ So far, support compared to Lynx Elements on the client:
9
+
10
+ | Elements | Whether support | Details |
11
+ | -------------- | --------------- | ------------ |
12
+ | Elements | | |
13
+ | image | ✅ | Full Support |
14
+ | list | ✅ | Full Support |
15
+ | scroll-view | ✅ | Full Support |
16
+ | text | ✅ | Full Support |
17
+ | view | ✅ | Full Support |
18
+ | X-Elements | | |
19
+ | svg | ✅ | Full Support |
20
+ | x-blur-view | ✅ | Full Support |
21
+ | x-input | ✅ | Full Support |
22
+ | x-textarea | ✅ | Full Support |
23
+ | x-swiper | ✅ | Full Support |
24
+ | x-viewpager-ng | ✅ | Full Support |
25
+ | x-foldview-ng | ✅ | Full Support |
26
+ | x-refresh-view | ✅ | Full Support |
27
+ | x-overlay-ng | ✅ | Full Support |
28
+ | x-audio-tt | ✅ | Full Support |
29
+
30
+ ## Usage
31
+
32
+ ```javascript
33
+ import '@lynx-js/web-elements/all';
34
+ import '@lynx-js/web-elements/index.css';
35
+
36
+ document.body.innerHTML = `
37
+ <x-text style="font-size: 24px;font-weight: bold">
38
+ Hello lynx.
39
+ </x-text>
40
+ `;
41
+ ```
42
+
43
+ ### Mouse-drag scrolling
44
+
45
+ To make `<scroll-view>` respond to mouse dragging like a touchscreen, load
46
+ the optional plugin before registering the elements:
47
+
48
+ ```javascript
49
+ import '@lynx-js/web-elements/plugins/scroll-view-mouse-drag';
50
+ import '@lynx-js/web-elements/all';
51
+ import '@lynx-js/web-elements/index.css';
52
+ ```
53
+
54
+ The plugin only changes `<scroll-view>` and leaves native touch scrolling
55
+ unchanged.
56
+
57
+ ## Document
58
+
59
+ See our website for more information.
60
+
@@ -1,3 +1,9 @@
1
1
  # @lynx-js/web-explorer
2
2
 
3
3
  [npm](https://www.npmjs.com/package/@lynx-js/web-explorer) · [Source](https://github.com/lynx-family/lynx-stack/tree/main/packages/web-platform/web-explorer) · [Changelog](https://github.com/lynx-family/lynx-stack/blob/main/packages/web-platform/web-explorer/CHANGELOG.md)
4
+
5
+
6
+ A web application for previewing Lynx bundles with Lynx for Web.
7
+
8
+ This package ships the explorer application rather than a JavaScript API.
9
+
@@ -1 +1,12 @@
1
- []
1
+ [
2
+ {
3
+ "type": "file",
4
+ "name": "functions/createGetTemplateName",
5
+ "label": "createGetTemplateName"
6
+ },
7
+ {
8
+ "type": "file",
9
+ "name": "functions/createLynx",
10
+ "label": "createLynx"
11
+ }
12
+ ]
@@ -0,0 +1,14 @@
1
+ # 函数: createGetTemplateName()
2
+
3
+ > **createGetTemplateName**(`fixedTool`: `Tool` \| `undefined`, `tool?`: `Tool` \| `undefined`): (`argv`: `Argv`) => `Promise`\<`string`\>
4
+
5
+ ## 参数
6
+
7
+ | 参数 | 类型 | 默认值 |
8
+ | ------ | ------ | ------ |
9
+ | `fixedTool` | `Tool` \| `undefined` | `undefined` |
10
+ | `tool` | `Tool` \| `undefined` | `fixedTool` |
11
+
12
+ ## 返回
13
+
14
+ (`argv`: `Argv`) => `Promise`\<`string`\>
@@ -0,0 +1,15 @@
1
+ # 函数: createLynx()
2
+
3
+ > **createLynx**(`options?`: [`CreateLynxOptions`](../interfaces/CreateLynxOptions.mdx)): `Promise`\<`void`\>
4
+
5
+ 创建 Lynx 项目脚手架。
6
+
7
+ ## 参数
8
+
9
+ | 参数 | 类型 |
10
+ | ------ | ------ |
11
+ | `options` | [`CreateLynxOptions`](../interfaces/CreateLynxOptions.mdx) |
12
+
13
+ ## 返回
14
+
15
+ `Promise`\<`void`\>
@@ -1,3 +1,49 @@
1
- # 模块: @lynx-js/create-lynx
1
+ # @lynx-js/create-lynx
2
2
 
3
3
  [npm](https://www.npmjs.com/package/@lynx-js/create-lynx) · [Source](https://github.com/lynx-family/lynx-stack/tree/main/packages/rspeedy/create-lynx) · [Changelog](https://github.com/lynx-family/lynx-stack/blob/main/packages/rspeedy/create-lynx/CHANGELOG.md)
4
+
5
+ 使用一条命令创建 [Lynx](https://lynxjs.org/) 应用或库。
6
+
7
+ ```bash
8
+ npm create @lynx-js/lynx@latest
9
+ ```
10
+
11
+ ## Templates
12
+
13
+ 模板命名格式为 `<build tool>-<DSL>-<language>`。省略的部分使用默认值,因此 `rsbuild`、`rsbuild-ts` 和 `rsbuild-react-ts` 均指向同一模板。
14
+
15
+ | Template | Creates | Build tool | Config |
16
+ | --------------------------------------- | ------- | ------------------------------------------------ | ------------------ |
17
+ | `rsbuild-react-ts` / `rsbuild-react-js` | App | [Rsbuild](https://rsbuild.rs/) with `pluginLynx` | `rsbuild.config.*` |
18
+ | `rspeedy-react-ts` / `rspeedy-react-js` | App | [Rspeedy](https://lynxjs.org/rspeedy/) | `lynx.config.*` |
19
+ | `rslib-react-ts` / `rslib-react-js` | Library | [Rslib](https://rslib.rs/) | `rslib.config.*` |
20
+
21
+ 每个模板均已配置 [Rstest](https://rstest.rs/) 和 `@lynx-js/react/testing-library`,可使用 `npm run test` 运行测试。
22
+
23
+ 库的输出保留 JSX(`dist/*.jsx`),由依赖它的 Lynx 应用使用自身的 ReactLynx 版本编译组件。选择 `external-bundle` 工具还可生成宿主应用在运行时加载的 Lynx External Bundle(`dist-external-bundle/*.lynx.bundle`)。
24
+
25
+ ```bash
26
+ npm create @lynx-js/lynx@latest my-app -- --template rsbuild-react-ts
27
+ npm create @lynx-js/lynx@latest my-lib -- --template rslib-react-ts
28
+ ```
29
+
30
+ ## Options
31
+
32
+ | Option | Description |
33
+ | ---------------- | -------------------------------------------------------------------------------------- |
34
+ | `-d, --dir` | 创建项目的目录 |
35
+ | `-t, --template` | 使用的模板 |
36
+ | `--tools` | 附加工具,例如 `eslint`、`prettier`、`biome`,或库使用的 `external-bundle` |
37
+ | `--skill` | 要安装的 Agent 技能 |
38
+ | `--override` | 覆盖目标目录中的文件 |
39
+
40
+ 此包取代 `create-rspeedy`。
41
+
42
+ ## 接口
43
+
44
+ - [CreateLynxOptions](interfaces/CreateLynxOptions.mdx)
45
+
46
+ ## 函数
47
+
48
+ - [createGetTemplateName](functions/createGetTemplateName.mdx)
49
+ - [createLynx](functions/createLynx.mdx)
@@ -0,0 +1,25 @@
1
+ # 接口: CreateLynxOptions
2
+
3
+ [createLynx](../functions/createLynx.mdx) 的选项。
4
+
5
+ ## 属性
6
+
7
+ ### name?
8
+
9
+ > `optional` **name?**: `string`
10
+
11
+ CLI 显示的名称。
12
+
13
+ #### 默认值
14
+
15
+ ```ts
16
+ 'lynx'
17
+ ```
18
+
19
+ ***
20
+
21
+ ### tool?
22
+
23
+ > `optional` **tool?**: `Tool`
24
+
25
+ 使用此工具构建项目,不再询问使用哪种工具。
@@ -1,3 +1,58 @@
1
1
  # @lynx-js/web-elements
2
2
 
3
3
  [npm](https://www.npmjs.com/package/@lynx-js/web-elements) · [Source](https://github.com/lynx-family/lynx-stack/tree/main/packages/web-platform/web-elements) · [Changelog](https://github.com/lynx-family/lynx-stack/blob/main/packages/web-platform/web-elements/CHANGELOG.md)
4
+
5
+
6
+ 提供 Lynx 元素在 Web 上的自定义元素实现。
7
+
8
+ 目前与客户端 Lynx 元素相比的支持情况:
9
+
10
+ | Elements | Whether support | Details |
11
+ | -------------- | --------------- | ------------ |
12
+ | Elements | | |
13
+ | image | ✅ | 完全支持 |
14
+ | list | ✅ | 完全支持 |
15
+ | scroll-view | ✅ | 完全支持 |
16
+ | text | ✅ | 完全支持 |
17
+ | view | ✅ | 完全支持 |
18
+ | X-Elements | | |
19
+ | svg | ✅ | 完全支持 |
20
+ | x-blur-view | ✅ | 完全支持 |
21
+ | x-input | ✅ | 完全支持 |
22
+ | x-textarea | ✅ | 完全支持 |
23
+ | x-swiper | ✅ | 完全支持 |
24
+ | x-viewpager-ng | ✅ | 完全支持 |
25
+ | x-foldview-ng | ✅ | 完全支持 |
26
+ | x-refresh-view | ✅ | 完全支持 |
27
+ | x-overlay-ng | ✅ | 完全支持 |
28
+ | x-audio-tt | ✅ | 完全支持 |
29
+
30
+ ## Usage
31
+
32
+ ```javascript
33
+ import '@lynx-js/web-elements/all';
34
+ import '@lynx-js/web-elements/index.css';
35
+
36
+ document.body.innerHTML = `
37
+ <x-text style="font-size: 24px;font-weight: bold">
38
+ Hello lynx.
39
+ </x-text>
40
+ `;
41
+ ```
42
+
43
+ ### Mouse-drag scrolling
44
+
45
+ 要让 `<scroll-view>` 像触摸屏一样响应鼠标拖动,请在注册元素前加载可选插件:
46
+
47
+ ```javascript
48
+ import '@lynx-js/web-elements/plugins/scroll-view-mouse-drag';
49
+ import '@lynx-js/web-elements/all';
50
+ import '@lynx-js/web-elements/index.css';
51
+ ```
52
+
53
+ 该插件仅改变 `<scroll-view>` 的行为,原生触摸滚动行为保持不变。
54
+
55
+ ## Document
56
+
57
+ 更多信息请参阅我们的网站。
58
+
@@ -1,3 +1,9 @@
1
1
  # @lynx-js/web-explorer
2
2
 
3
3
  [npm](https://www.npmjs.com/package/@lynx-js/web-explorer) · [Source](https://github.com/lynx-family/lynx-stack/tree/main/packages/web-platform/web-explorer) · [Changelog](https://github.com/lynx-family/lynx-stack/blob/main/packages/web-platform/web-explorer/CHANGELOG.md)
4
+
5
+
6
+ 用于通过 Lynx for Web 预览 Lynx bundle 的 Web 应用。
7
+
8
+ 此包提供预览应用,不提供 JavaScript API。
9
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lynx-js/lynx-stack-docs-canary",
3
- "version": "0.0.2-canary-20261016-00fbd033",
3
+ "version": "0.0.2",
4
4
  "description": "The Lynx Stack API reference as MDX pages: the build configuration, the Rsbuild plugins, ReactLynx and every @lynx-js package.",
5
5
  "keywords": [
6
6
  "Lynx",
@@ -26,7 +26,7 @@
26
26
  "@lynx-js/autolink-codegen": "npm:@lynx-js/autolink-codegen-canary@0.6.0",
27
27
  "@lynx-js/cache-events-webpack-plugin": "npm:@lynx-js/cache-events-webpack-plugin-canary@0.2.1",
28
28
  "@lynx-js/chunk-loading-webpack-plugin": "npm:@lynx-js/chunk-loading-webpack-plugin-canary@0.4.2",
29
- "@lynx-js/config-rsbuild-plugin": "npm:@lynx-js/config-rsbuild-plugin-canary@0.2.5-canary-20261016-00fbd033",
29
+ "@lynx-js/config-rsbuild-plugin": "npm:@lynx-js/config-rsbuild-plugin-canary@0.2.5",
30
30
  "@lynx-js/create-lynx": "npm:@lynx-js/create-lynx-canary@0.2.1",
31
31
  "@lynx-js/css-extract-webpack-plugin": "npm:@lynx-js/css-extract-webpack-plugin-canary@0.11.1",
32
32
  "@lynx-js/css-serializer": "npm:@lynx-js/css-serializer-canary@0.1.9",
@@ -34,7 +34,7 @@
34
34
  "@lynx-js/debug-metadata-rsbuild-plugin": "npm:@lynx-js/debug-metadata-rsbuild-plugin-canary@0.2.3",
35
35
  "@lynx-js/external-bundle-rsbuild-plugin": "npm:@lynx-js/external-bundle-rsbuild-plugin-canary@0.4.3",
36
36
  "@lynx-js/externals-loading-webpack-plugin": "npm:@lynx-js/externals-loading-webpack-plugin-canary@0.2.1",
37
- "@lynx-js/genui": "npm:@lynx-js/genui-canary@0.7.0-canary-20261016-00fbd033",
37
+ "@lynx-js/genui": "npm:@lynx-js/genui-canary@0.7.0",
38
38
  "@lynx-js/genui-a2ui": "0.0.0",
39
39
  "@lynx-js/genui-a2ui-catalog-extractor": "0.0.0",
40
40
  "@lynx-js/genui-a2ui-prompt": "0.0.0",
@@ -48,22 +48,22 @@
48
48
  "@lynx-js/lynx-bundle-rslib-config": "npm:@lynx-js/lynx-bundle-rslib-config-canary@0.8.1",
49
49
  "@lynx-js/motion": "npm:@lynx-js/motion-canary@0.0.7",
50
50
  "@lynx-js/qrcode-rsbuild-plugin": "npm:@lynx-js/qrcode-rsbuild-plugin-canary@0.7.3",
51
- "@lynx-js/react": "npm:@lynx-js/react-canary@0.128.0-canary-20261016-00fbd033",
52
- "@lynx-js/react-alias-rsbuild-plugin": "npm:@lynx-js/react-alias-rsbuild-plugin-canary@0.21.0-canary-20261016-00fbd033",
53
- "@lynx-js/react-refresh-webpack-plugin": "npm:@lynx-js/react-refresh-webpack-plugin-canary@0.4.4-canary-20261016-00fbd033",
54
- "@lynx-js/react-rsbuild-plugin": "npm:@lynx-js/react-rsbuild-plugin-canary@0.21.0-canary-20261016-00fbd033",
55
- "@lynx-js/react-signals": "npm:@lynx-js/react-signals-canary@0.0.6-canary-20261016-00fbd033",
56
- "@lynx-js/react-webpack-plugin": "npm:@lynx-js/react-webpack-plugin-canary@0.13.0-canary-20261016-00fbd033",
51
+ "@lynx-js/react": "npm:@lynx-js/react-canary@0.128.0",
52
+ "@lynx-js/react-alias-rsbuild-plugin": "npm:@lynx-js/react-alias-rsbuild-plugin-canary@0.21.0",
53
+ "@lynx-js/react-refresh-webpack-plugin": "npm:@lynx-js/react-refresh-webpack-plugin-canary@0.4.4",
54
+ "@lynx-js/react-rsbuild-plugin": "npm:@lynx-js/react-rsbuild-plugin-canary@0.21.0",
55
+ "@lynx-js/react-signals": "npm:@lynx-js/react-signals-canary@0.0.6",
56
+ "@lynx-js/react-webpack-plugin": "npm:@lynx-js/react-webpack-plugin-canary@0.13.0",
57
57
  "@lynx-js/reactlynx-testing-library": "0.0.0",
58
- "@lynx-js/rsbuild-plugin": "npm:@lynx-js/rsbuild-plugin-canary@0.1.5-canary-20261016-00fbd033",
59
- "@lynx-js/rspeedy": "npm:@lynx-js/rspeedy-canary@0.18.2-canary-20261016-00fbd033",
58
+ "@lynx-js/rsbuild-plugin": "npm:@lynx-js/rsbuild-plugin-canary@0.1.5",
59
+ "@lynx-js/rspeedy": "npm:@lynx-js/rspeedy-canary@0.18.2",
60
60
  "@lynx-js/runtime-config-webpack-plugin": "npm:@lynx-js/runtime-config-webpack-plugin-canary@0.0.1",
61
61
  "@lynx-js/runtime-wrapper-webpack-plugin": "npm:@lynx-js/runtime-wrapper-webpack-plugin-canary@0.2.4",
62
- "@lynx-js/template-webpack-plugin": "npm:@lynx-js/template-webpack-plugin-canary@0.16.4-canary-20261016-00fbd033",
63
- "@lynx-js/testing-environment": "npm:@lynx-js/testing-environment-canary@0.4.0-canary-20261016-00fbd033",
64
- "@lynx-js/vanilla-rsbuild-plugin": "npm:@lynx-js/vanilla-rsbuild-plugin-canary@0.1.4-canary-20261016-00fbd033",
62
+ "@lynx-js/template-webpack-plugin": "npm:@lynx-js/template-webpack-plugin-canary@0.16.4",
63
+ "@lynx-js/testing-environment": "npm:@lynx-js/testing-environment-canary@0.4.0",
64
+ "@lynx-js/vanilla-rsbuild-plugin": "npm:@lynx-js/vanilla-rsbuild-plugin-canary@0.1.4",
65
65
  "@lynx-js/web-platform-rsbuild-plugin": "npm:@lynx-js/web-platform-rsbuild-plugin-canary@0.1.2",
66
- "@lynx-js/web-worker-rpc": "npm:@lynx-js/web-worker-rpc-canary@0.26.4-canary-20261016-00fbd033",
66
+ "@lynx-js/web-worker-rpc": "npm:@lynx-js/web-worker-rpc-canary@0.26.4",
67
67
  "@lynx-js/webpack-runtime-globals": "npm:@lynx-js/webpack-runtime-globals-canary@0.0.8",
68
68
  "@lynx-js/websocket": "npm:@lynx-js/websocket-canary@0.0.4",
69
69
  "@rspress/core": "2.0.21",