@ansible/ansible-ui-framework 0.0.371 → 0.0.372
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.
- package/docs/guides/GettingStarted.md +10 -10
- package/package.json +1 -1
|
@@ -12,7 +12,7 @@ npm install @ansible/ansible-ui-framework
|
|
|
12
12
|
|
|
13
13
|
## Add the PageFramework to your application
|
|
14
14
|
|
|
15
|
-
Near the top of your application add the [PageFramework](
|
|
15
|
+
Near the top of your application add the [PageFramework](../componentsPageFramework.md) component.
|
|
16
16
|
|
|
17
17
|
This component adds the state management needed by the framework.
|
|
18
18
|
|
|
@@ -20,7 +20,7 @@ This component adds the state management needed by the framework.
|
|
|
20
20
|
|
|
21
21
|
### Use PageLayout to control the layout in your pages
|
|
22
22
|
|
|
23
|
-
The [PageLayout](components/PageLayout.md) is used as the container for the contents of the page. It enables page components to leverage full page layout and scrolling of sub content. An example is a full page table where the page header, toolbar, column headers, and pagination stay fixed, but the rows of the table can scroll.
|
|
23
|
+
The [PageLayout](../components/PageLayout.md) is used as the container for the contents of the page. It enables page components to leverage full page layout and scrolling of sub content. An example is a full page table where the page header, toolbar, column headers, and pagination stay fixed, but the rows of the table can scroll.
|
|
24
24
|
|
|
25
25
|
```tsx
|
|
26
26
|
<Page>
|
|
@@ -33,7 +33,7 @@ The [PageLayout](components/PageLayout.md) is used as the container for the cont
|
|
|
33
33
|
|
|
34
34
|
### Use PageHeader for the heading of your pages
|
|
35
35
|
|
|
36
|
-
The [PageHeader](
|
|
36
|
+
The [PageHeader](../componentsPageHeader.md) is used at the top of each page. It provides a consistent layout of header elements.
|
|
37
37
|
|
|
38
38
|
```tsx
|
|
39
39
|
<Page>
|
|
@@ -48,7 +48,7 @@ The [PageHeader](components/PageHeader.md) is used at the top of each page. It p
|
|
|
48
48
|
|
|
49
49
|
#### Table Pages
|
|
50
50
|
|
|
51
|
-
For pages containing a table, use the [PageTable](
|
|
51
|
+
For pages containing a table, use the [PageTable](../componentsPageTable.md) component. The PageTable support table, list, and card views of the data.
|
|
52
52
|
|
|
53
53
|
```tsx
|
|
54
54
|
<Page>
|
|
@@ -61,7 +61,7 @@ For pages containing a table, use the [PageTable](components/PageTable.md) compo
|
|
|
61
61
|
|
|
62
62
|
<!-- #### Form Pages
|
|
63
63
|
|
|
64
|
-
For pages containing an input form, use the [PageForm](
|
|
64
|
+
For pages containing an input form, use the [PageForm](../componentsPageForm.md) component.
|
|
65
65
|
|
|
66
66
|
```tsx
|
|
67
67
|
<Page>
|
|
@@ -82,9 +82,9 @@ TODO -->
|
|
|
82
82
|
|
|
83
83
|
### Other Useful Components
|
|
84
84
|
|
|
85
|
-
<!-- - [PageAlertToaster](
|
|
85
|
+
<!-- - [PageAlertToaster](../componentsPageAlertToaster.md) -->
|
|
86
86
|
|
|
87
|
-
- [BulkActionDialog](
|
|
88
|
-
<!-- - [BulkConfirmationDialog](
|
|
89
|
-
<!-- - [SelectDialog](
|
|
90
|
-
<!-- - [SelectMultipleDialog](
|
|
87
|
+
- [BulkActionDialog](../componentsBulkActionDialog.md)
|
|
88
|
+
<!-- - [BulkConfirmationDialog](../componentsBulkConfirmationDialog.md) -->
|
|
89
|
+
<!-- - [SelectDialog](../componentsSelectDialog.md) -->
|
|
90
|
+
<!-- - [SelectMultipleDialog](../componentsSelectMultipleDialog.md) -->
|