@ansible/ansible-ui-framework 0.0.309 → 0.0.311
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +1 -1
- package/docs/BulkActionDialog.md +1 -1
- package/docs/Components.md +6 -6
- package/docs/Framework.md +3 -3
- package/docs/GettingStarted.md +7 -7
- package/docs/Guides.md +4 -4
- package/docs/PageFramework.md +1 -1
- package/docs/PageHeader.md +1 -1
- package/docs/PageLayout.md +1 -1
- package/docs/PageTable.md +1 -1
- package/docs/PageTableGuide.md +1 -1
- package/docs/_config.yml +4 -0
- package/docs/index.md +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
@@ -2,4 +2,4 @@
|
|
2
2
|
|
3
3
|
A framework for building applications using [PatternFly](https://www.patternfly.org), developed by the Ansible UI developers.
|
4
4
|
|
5
|
-
[Documentation](https://github.com/ansible/ansible-ui/blob/main/framework/docs/Framework.md
|
5
|
+
[Documentation](https://github.com/ansible/ansible-ui/blob/main/framework/docs/Framework.md)
|
package/docs/BulkActionDialog.md
CHANGED
package/docs/Components.md
CHANGED
@@ -1,9 +1,9 @@
|
|
1
|
-
[Ansible UI Framework](Framework.md
|
1
|
+
[Ansible UI Framework](Framework.md) ▸ Components
|
2
2
|
|
3
3
|
# Ansible UI Components
|
4
4
|
|
5
|
-
- [BulkActionDialog](BulkActionDialog.md
|
6
|
-
- [PageFramework](PageFramework.md
|
7
|
-
- [PageHeader](PageHeader.md
|
8
|
-
- [PageLayout](PageLayout.md
|
9
|
-
- [PageTable](PageTable.md
|
5
|
+
- [BulkActionDialog](BulkActionDialog.md)
|
6
|
+
- [PageFramework](PageFramework.md)
|
7
|
+
- [PageHeader](PageHeader.md)
|
8
|
+
- [PageLayout](PageLayout.md)
|
9
|
+
- [PageTable](PageTable.md)
|
package/docs/Framework.md
CHANGED
@@ -4,9 +4,9 @@ Ansible UI Framework
|
|
4
4
|
|
5
5
|
A framework for building applications using [PatternFly](https://www.patternfly.org).
|
6
6
|
|
7
|
-
- [Getting Started](GettingStarted.md
|
8
|
-
- [Guides](Guides.md
|
9
|
-
- [Components](Components.md
|
7
|
+
- [Getting Started](GettingStarted.md)
|
8
|
+
- [Guides](Guides.md)
|
9
|
+
- [Components](Components.md)
|
10
10
|
|
11
11
|
The framework is made up of high level components using PatternFly components underneath.
|
12
12
|
This allows the framework to adjust the web application for responsive layout.
|
package/docs/GettingStarted.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
[Ansible UI Framework](Framework.md
|
1
|
+
[Ansible UI Framework](Framework.md) ▸ [Guides](Guides.md) ▸ Getting Started
|
2
2
|
|
3
3
|
# Getting Started
|
4
4
|
|
@@ -14,9 +14,9 @@ There is an [Ansible UI Framework Demo](https://github.com/jamestalton/ansible-u
|
|
14
14
|
npm install @ansible/ansible-ui-framework
|
15
15
|
```
|
16
16
|
|
17
|
-
## Add the [PageFramework](PageFramework.md
|
17
|
+
## Add the [PageFramework](PageFramework.md) to your application
|
18
18
|
|
19
|
-
Near the top of your application add the [PageFramework](https://github.com/ansible/ansible-ui/blob/main/framework/docs/PageFramework.md
|
19
|
+
Near the top of your application add the [PageFramework](https://github.com/ansible/ansible-ui/blob/main/framework/docs/PageFramework.md) component.
|
20
20
|
|
21
21
|
This component adds the state management needed by the framework.
|
22
22
|
|
@@ -24,7 +24,7 @@ This component adds the state management needed by the framework.
|
|
24
24
|
|
25
25
|
### Use PageLayout to control the layout in your pages
|
26
26
|
|
27
|
-
The [PageLayout](https://github.com/ansible/ansible-ui/blob/main/framework/docs/PageLayout.md
|
27
|
+
The [PageLayout](https://github.com/ansible/ansible-ui/blob/main/framework/docs/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 that the page header, toolbar, column headers, and pagination stay fixed, but the rows of the table can scroll.
|
28
28
|
|
29
29
|
```tsx
|
30
30
|
<Page>
|
@@ -37,7 +37,7 @@ The [PageLayout](https://github.com/ansible/ansible-ui/blob/main/framework/docs/
|
|
37
37
|
|
38
38
|
### Use PageHeader for the heading of your pages
|
39
39
|
|
40
|
-
The [PageHeader](https://github.com/ansible/ansible-ui/blob/main/framework/docs/PageHeader.md
|
40
|
+
The [PageHeader](https://github.com/ansible/ansible-ui/blob/main/framework/docs/PageHeader.md) is used at the top of each page. It provides a consistent layout of header elements.
|
41
41
|
|
42
42
|
```tsx
|
43
43
|
<Page>
|
@@ -52,7 +52,7 @@ The [PageHeader](https://github.com/ansible/ansible-ui/blob/main/framework/docs/
|
|
52
52
|
|
53
53
|
#### Table Pages
|
54
54
|
|
55
|
-
For pages containing a table, use the [PageTable](https://github.com/ansible/ansible-ui/blob/main/framework/docs/PageTable.md
|
55
|
+
For pages containing a table, use the [PageTable](https://github.com/ansible/ansible-ui/blob/main/framework/docs/PageTable.md) component.
|
56
56
|
|
57
57
|
```tsx
|
58
58
|
<Page>
|
@@ -65,7 +65,7 @@ For pages containing a table, use the [PageTable](https://github.com/ansible/ans
|
|
65
65
|
|
66
66
|
#### Form Pages
|
67
67
|
|
68
|
-
For pages containing an input form, use the [PageForm](https://github.com/ansible/ansible-ui/blob/main/framework/docs/PageForm.md
|
68
|
+
For pages containing an input form, use the [PageForm](https://github.com/ansible/ansible-ui/blob/main/framework/docs/PageForm.md) component.
|
69
69
|
|
70
70
|
```tsx
|
71
71
|
<Page>
|
package/docs/Guides.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
|
-
[Ansible UI Framework](Framework.md
|
1
|
+
[Ansible UI Framework](Framework.md) ▸ Guides
|
2
2
|
|
3
3
|
# Ansible UI Guides
|
4
4
|
|
5
|
-
- [Getting Started](GettingStarted.md
|
6
|
-
- [PageLayout](PageLayout.md
|
7
|
-
- [PageTable Guide](PageTableGuide.md
|
5
|
+
- [Getting Started](GettingStarted.md)
|
6
|
+
- [PageLayout](PageLayout.md)
|
7
|
+
- [PageTable Guide](PageTableGuide.md)
|
package/docs/PageFramework.md
CHANGED
package/docs/PageHeader.md
CHANGED
package/docs/PageLayout.md
CHANGED
package/docs/PageTable.md
CHANGED
package/docs/PageTableGuide.md
CHANGED
package/docs/_config.yml
CHANGED
package/docs/index.md
CHANGED
@@ -4,9 +4,9 @@ Ansible UI Framework
|
|
4
4
|
|
5
5
|
A framework for building applications using [PatternFly](https://www.patternfly.org).
|
6
6
|
|
7
|
-
- [Getting Started](GettingStarted.md
|
8
|
-
- [Guides](Guides.md
|
9
|
-
- [Components](Components.md
|
7
|
+
- [Getting Started](GettingStarted.md)
|
8
|
+
- [Guides](Guides.md)
|
9
|
+
- [Components](Components.md)
|
10
10
|
|
11
11
|
The framework is made up of high level components using PatternFly components underneath.
|
12
12
|
This allows the framework to adjust the web application for responsive layout.
|