@patternfly/patternfly 4.202.2 → 4.203.0
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/base/_fonts.scss +10 -10
- package/base/_shield-inheritable.scss +1 -1
- package/base/patternfly-fonts.css +10 -10
- package/base/patternfly-shield-inheritable.css +1 -1
- package/components/AlertGroup/alert-group.css +1 -1
- package/components/Button/button.css +1 -1
- package/components/Button/button.scss +1 -1
- package/components/Divider/divider.css +12 -12
- package/components/Drawer/drawer.css +0 -33
- package/components/JumpLinks/jump-links.css +1 -1
- package/components/JumpLinks/jump-links.scss +1 -1
- package/components/MenuToggle/menu-toggle.css +1 -1
- package/components/MenuToggle/menu-toggle.scss +1 -1
- package/components/ProgressStepper/progress-stepper.css +1 -1
- package/components/Sidebar/sidebar.css +0 -30
- package/components/Spinner/spinner.css +2 -2
- package/components/Table/table.css +5 -5
- package/components/Table/table.scss +5 -5
- package/components/Tabs/tabs.css +1 -1
- package/components/Tabs/tabs.scss +1 -1
- package/components/TreeView/tree-view.css +29 -1
- package/components/TreeView/tree-view.scss +36 -2
- package/docs/components/TreeView/examples/TreeView.md +1077 -677
- package/package.json +6 -6
- package/patternfly-addons.css +48 -683
- package/patternfly-base-no-reset.css +10 -10
- package/patternfly-base.css +10 -10
- package/patternfly-no-reset.css +64 -99
- package/patternfly.css +64 -99
- package/patternfly.min.css +1 -1
- package/patternfly.min.css.map +1 -1
- package/utilities/Alignment/alignment.css +0 -15
- package/utilities/BackgroundColor/BackgroundColor.css +0 -75
- package/utilities/Display/display.css +0 -40
- package/utilities/Flex/flex.css +0 -140
- package/utilities/Float/float.css +0 -5
- package/utilities/Sizing/sizing.css +48 -198
- package/utilities/Text/text.css +0 -210
- package/docs/pages/accessibility-guide.md +0 -161
- package/docs/pages/contribution.md +0 -109
- package/docs/pages/guidelines.md +0 -367
- package/docs/pages/icons.md +0 -129
- package/docs/pages/index.js +0 -13
- package/docs/pages/reference-docs/PF-quick-ref.key +0 -0
- package/docs/pages/reference-docs/PF-quick-ref.pdf +0 -0
- package/docs/pages/upgrade-guide.md +0 -188
package/docs/pages/icons.md
DELETED
|
@@ -1,129 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
id: Icons
|
|
3
|
-
---
|
|
4
|
-
| Icon name | Icon | Code |
|
|
5
|
-
| --- | --- | --- |
|
|
6
|
-
| add-circle-o | <i class="pf-icon pf-icon-add-circle-o"></i> | <i class="pf-icon pf-icon-add-circle-o"></i>
|
|
7
|
-
| ansible-tower | <i class="pf-icon pf-icon-ansible-tower"></i> | <i class="pf-icon pf-icon-ansible-tower"></i>
|
|
8
|
-
| applications | <i class="pf-icon pf-icon-applications"></i> | <i class="pf-icon pf-icon-applications"></i>
|
|
9
|
-
| arrow | <i class="pf-icon pf-icon-arrow"></i> | <i class="pf-icon pf-icon-arrow"></i>
|
|
10
|
-
| asleep | <i class="pf-icon pf-icon-asleep"></i> | <i class="pf-icon pf-icon-asleep"></i>
|
|
11
|
-
| attention-bell | <i class="pf-icon pf-icon-attention-bell"></i> | <i class="pf-icon pf-icon-attention-bell"></i>
|
|
12
|
-
| automation | <i class="pf-icon pf-icon-automation"></i> | <i class="pf-icon pf-icon-automation"></i>
|
|
13
|
-
| bell | <i class="pf-icon pf-icon-bell"></i> | <i class="pf-icon pf-icon-bell"></i>
|
|
14
|
-
| blueprint | <i class="pf-icon pf-icon-blueprint"></i> | <i class="pf-icon pf-icon-blueprint"></i>
|
|
15
|
-
| build | <i class="pf-icon pf-icon-build"></i> | <i class="pf-icon pf-icon-build"></i>
|
|
16
|
-
| builder-image | <i class="pf-icon pf-icon-builder-image"></i> | <i class="pf-icon pf-icon-builder-image"></i>
|
|
17
|
-
| bundle | <i class="pf-icon pf-icon-bundle"></i> | <i class="pf-icon pf-icon-bundle"></i>
|
|
18
|
-
| catalog | <i class="pf-icon pf-icon-catalog"></i> | <i class="pf-icon pf-icon-catalog"></i>
|
|
19
|
-
| chat | <i class="pf-icon pf-icon-chat"></i> | <i class="pf-icon pf-icon-chat"></i>
|
|
20
|
-
| close | <i class="pf-icon pf-icon-close"></i> | <i class="pf-icon pf-icon-close"></i>
|
|
21
|
-
| cloud-security | <i class="pf-icon pf-icon-cloud-security"></i> | <i class="pf-icon pf-icon-cloud-security"></i>
|
|
22
|
-
| cloud-tenant | <i class="pf-icon pf-icon-cloud-tenant"></i> | <i class="pf-icon pf-icon-cloud-tenant"></i>
|
|
23
|
-
| cluster | <i class="pf-icon pf-icon-cluster"></i> | <i class="pf-icon pf-icon-cluster"></i>
|
|
24
|
-
| connected | <i class="pf-icon pf-icon-connected"></i> | <i class="pf-icon pf-icon-connected"></i>
|
|
25
|
-
| container-node | <i class="pf-icon pf-icon-container-node"></i> | <i class="pf-icon pf-icon-container-node"></i>
|
|
26
|
-
| cpu | <i class="pf-icon pf-icon-cpu"></i> | <i class="pf-icon pf-icon-cpu"></i>
|
|
27
|
-
| critical-risk | <i class="pf-icon pf-icon-critical-risk"></i> | <i class="pf-icon pf-icon-critical-risk"></i>
|
|
28
|
-
| degraded | <i class="pf-icon pf-icon-degraded"></i> | <i class="pf-icon pf-icon-degraded"></i>
|
|
29
|
-
| disconnected | <i class="pf-icon pf-icon-disconnected"></i> | <i class="pf-icon pf-icon-disconnected"></i>
|
|
30
|
-
| domain | <i class="pf-icon pf-icon-domain"></i> | <i class="pf-icon pf-icon-domain"></i>
|
|
31
|
-
| edit | <i class="pf-icon pf-icon-edit"></i> | <i class="pf-icon pf-icon-edit"></i>
|
|
32
|
-
| enhancement | <i class="pf-icon pf-icon-enhancement"></i> | <i class="pf-icon pf-icon-enhancement"></i>
|
|
33
|
-
| enterprise | <i class="pf-icon pf-icon-enterprise"></i> | <i class="pf-icon pf-icon-enterprise"></i>
|
|
34
|
-
| equalizer | <i class="pf-icon pf-icon-equalizer"></i> | <i class="pf-icon pf-icon-equalizer"></i>
|
|
35
|
-
| error-circle-o | <i class="pf-icon pf-icon-error-circle-o"></i> | <i class="pf-icon pf-icon-error-circle-o"></i>
|
|
36
|
-
| export | <i class="pf-icon pf-icon-export"></i> | <i class="pf-icon pf-icon-export"></i>
|
|
37
|
-
| filter | <i class="pf-icon pf-icon-filter"></i> | <i class="pf-icon pf-icon-filter"></i>
|
|
38
|
-
| flavor | <i class="pf-icon pf-icon-flavor"></i> | <i class="pf-icon pf-icon-flavor"></i>
|
|
39
|
-
| folder-close | <i class="pf-icon pf-icon-folder-close"></i> | <i class="pf-icon pf-icon-folder-close"></i>
|
|
40
|
-
| folder-open | <i class="pf-icon pf-icon-folder-open"></i> | <i class="pf-icon pf-icon-folder-open"></i>
|
|
41
|
-
| globe-route | <i class="pf-icon pf-icon-globe-route"></i> | <i class="pf-icon pf-icon-globe-route"></i>
|
|
42
|
-
| help | <i class="pf-icon pf-icon-help"></i> | <i class="pf-icon pf-icon-help"></i>
|
|
43
|
-
| history | <i class="pf-icon pf-icon-history"></i> | <i class="pf-icon pf-icon-history"></i>
|
|
44
|
-
| home | <i class="pf-icon pf-icon-home"></i> | <i class="pf-icon pf-icon-home"></i>
|
|
45
|
-
| import | <i class="pf-icon pf-icon-import"></i> | <i class="pf-icon pf-icon-import"></i>
|
|
46
|
-
| in-progress | <i class="pf-icon pf-icon-in-progress"></i> | <i class="pf-icon pf-icon-in-progress"></i>
|
|
47
|
-
| info | <i class="pf-icon pf-icon-info"></i> | <i class="pf-icon pf-icon-info"></i>
|
|
48
|
-
| infrastructure | <i class="pf-icon pf-icon-infrastructure"></i> | <i class="pf-icon pf-icon-infrastructure"></i>
|
|
49
|
-
| integration | <i class="pf-icon pf-icon-integration"></i> | <i class="pf-icon pf-icon-integration"></i>
|
|
50
|
-
| key | <i class="pf-icon pf-icon-key"></i> | <i class="pf-icon pf-icon-key"></i>
|
|
51
|
-
| locked | <i class="pf-icon pf-icon-locked"></i> | <i class="pf-icon pf-icon-locked"></i>
|
|
52
|
-
| maintenance | <i class="pf-icon pf-icon-maintenance"></i> | <i class="pf-icon pf-icon-maintenance"></i>
|
|
53
|
-
| memory | <i class="pf-icon pf-icon-memory"></i> | <i class="pf-icon pf-icon-memory"></i>
|
|
54
|
-
| messages | <i class="pf-icon pf-icon-messages"></i> | <i class="pf-icon pf-icon-messages"></i>
|
|
55
|
-
| middleware | <i class="pf-icon pf-icon-middleware"></i> | <i class="pf-icon pf-icon-middleware"></i>
|
|
56
|
-
| migration | <i class="pf-icon pf-icon-migration"></i> | <i class="pf-icon pf-icon-migration"></i>
|
|
57
|
-
| module | <i class="pf-icon pf-icon-module"></i> | <i class="pf-icon pf-icon-module"></i>
|
|
58
|
-
| monitoring | <i class="pf-icon pf-icon-monitoring"></i> | <i class="pf-icon pf-icon-monitoring"></i>
|
|
59
|
-
| namespaces | <i class="pf-icon pf-icon-namespaces"></i> | <i class="pf-icon pf-icon-namespaces"></i>
|
|
60
|
-
| not-started | <i class="pf-icon pf-icon-not-started"></i> | <i class="pf-icon pf-icon-not-started"></i>
|
|
61
|
-
| network | <i class="pf-icon pf-icon-network"></i> | <i class="pf-icon pf-icon-network"></i>
|
|
62
|
-
| new-process | <i class="pf-icon pf-icon-new-process"></i> | <i class="pf-icon pf-icon-new-process"></i>
|
|
63
|
-
| off | <i class="pf-icon pf-icon-off"></i> | <i class="pf-icon pf-icon-off"></i>
|
|
64
|
-
| ok | <i class="pf-icon pf-icon-ok"></i> | <i class="pf-icon pf-icon-ok"></i>
|
|
65
|
-
| on-running | <i class="pf-icon pf-icon-on-running"></i> | <i class="pf-icon pf-icon-on-running"></i>
|
|
66
|
-
| on | <i class="pf-icon pf-icon-on"></i> | <i class="pf-icon pf-icon-on"></i>
|
|
67
|
-
| openshift | <i class="pf-icon pf-icon-openshift"></i> | <i class="pf-icon pf-icon-openshift"></i>
|
|
68
|
-
| openstack | <i class="pf-icon pf-icon-openstack"></i> | <i class="pf-icon pf-icon-openstack"></i>
|
|
69
|
-
| optimize | <i class="pf-icon pf-icon-optimize"></i> | <i class="pf-icon pf-icon-optimize"></i>
|
|
70
|
-
| orders | <i class="pf-icon pf-icon-orders"></i> | <i class="pf-icon pf-icon-orders"></i>
|
|
71
|
-
| os-image | <i class="pf-icon pf-icon-os-image"></i> | <i class="pf-icon pf-icon-os-image"></i>
|
|
72
|
-
| package | <i class="pf-icon pf-icon-package"></i> | <i class="pf-icon pf-icon-package"></i>
|
|
73
|
-
| panel-open | <i class="pf-icon pf-icon-panel-open"></i> | <i class="pf-icon pf-icon-panel-open"></i>
|
|
74
|
-
| panel-close | <i class="pf-icon pf-icon-panel-close"></i> | <i class="pf-icon pf-icon-panel-close"></i>
|
|
75
|
-
| paused | <i class="pf-icon pf-icon-paused"></i> | <i class="pf-icon pf-icon-paused"></i>
|
|
76
|
-
| pending | <i class="pf-icon pf-icon-pending"></i> | <i class="pf-icon pf-icon-pending"></i>
|
|
77
|
-
| pficon-dragdrop | <i class="pf-icon pf-icon-pficon-dragdrop"></i> | <i class="pf-icon pf-icon-pficon-dragdrop"></i>
|
|
78
|
-
| pficon-history | <i class="pf-icon pf-icon-pficon-history"></i> | <i class="pf-icon pf-icon-pficon-history"></i>
|
|
79
|
-
| pficon-network-range | <i class="pf-icon pf-icon-pficon-network-range"></i> | <i class="pf-icon pf-icon-pficon-network-range"></i>
|
|
80
|
-
| pficon-satellite | <i class="pf-icon pf-icon-pficon-satellite"></i> | <i class="pf-icon pf-icon-pficon-satellite"></i>
|
|
81
|
-
| pficon-sort-common-asc | <i class="pf-icon pf-icon-pficon-sort-common-asc"></i> | <i class="pf-icon pf-icon-pficon-sort-common-asc"></i>
|
|
82
|
-
| pficon-sort-common-desc | <i class="pf-icon pf-icon-pficon-sort-common-desc"></i> | <i class="pf-icon pf-icon-pficon-sort-common-desc"></i>
|
|
83
|
-
| pficon-template | <i class="pf-icon pf-icon-pficon-template"></i> | <i class="pf-icon pf-icon-pficon-template"></i>
|
|
84
|
-
| pficon-vcenter | <i class="pf-icon pf-icon-pficon-vcenter"></i> | <i class="pf-icon pf-icon-pficon-vcenter"></i>
|
|
85
|
-
| plugged | <i class="pf-icon pf-icon-plugged"></i> | <i class="pf-icon pf-icon-plugged"></i>
|
|
86
|
-
| port | <i class="pf-icon pf-icon-port"></i> | <i class="pf-icon pf-icon-port"></i>
|
|
87
|
-
| print | <i class="pf-icon pf-icon-print"></i> | <i class="pf-icon pf-icon-print"></i>
|
|
88
|
-
| private | <i class="pf-icon pf-icon-private"></i> | <i class="pf-icon pf-icon-private"></i>
|
|
89
|
-
| process-automation | <i class="pf-icon pf-icon-process-automation"></i> | <i class="pf-icon pf-icon-process-automation"></i>
|
|
90
|
-
| project | <i class="pf-icon pf-icon-project"></i> | <i class="pf-icon pf-icon-project"></i>
|
|
91
|
-
| rebalance | <i class="pf-icon pf-icon-rebalance"></i> | <i class="pf-icon pf-icon-rebalance"></i>
|
|
92
|
-
| rebooting | <i class="pf-icon pf-icon-rebooting"></i> | <i class="pf-icon pf-icon-rebooting"></i>
|
|
93
|
-
| regions | <i class="pf-icon pf-icon-regions"></i> | <i class="pf-icon pf-icon-regions"></i>
|
|
94
|
-
| registry | <i class="pf-icon pf-icon-registry"></i> | <i class="pf-icon pf-icon-registry"></i>
|
|
95
|
-
| remove2 | <i class="pf-icon pf-icon-remove2"></i> | <i class="pf-icon pf-icon-remove2"></i>
|
|
96
|
-
| replicator | <i class="pf-icon pf-icon-replicator"></i> | <i class="pf-icon pf-icon-replicator"></i>
|
|
97
|
-
| repository | <i class="pf-icon pf-icon-repository"></i> | <i class="pf-icon pf-icon-repository"></i>
|
|
98
|
-
| resource-pool | <i class="pf-icon pf-icon-resource-pool"></i> | <i class="pf-icon pf-icon-resource-pool"></i>
|
|
99
|
-
| resources-almost-empty | <i class="pf-icon pf-icon-resources-almost-empty"></i> | <i class="pf-icon pf-icon-resources-almost-empty"></i>
|
|
100
|
-
| resources-almost-full | <i class="pf-icon pf-icon-resources-almost-full"></i> | <i class="pf-icon pf-icon-resources-almost-full"></i>
|
|
101
|
-
| resources-empty | <i class="pf-icon pf-icon-resources-empty"></i> | <i class="pf-icon pf-icon-resources-empty"></i>
|
|
102
|
-
| resources-full | <i class="pf-icon pf-icon-resources-full"></i> | <i class="pf-icon pf-icon-resources-full"></i>
|
|
103
|
-
| running | <i class="pf-icon pf-icon-running"></i> | <i class="pf-icon pf-icon-running"></i>
|
|
104
|
-
| save | <i class="pf-icon pf-icon-save"></i> | <i class="pf-icon pf-icon-save"></i>
|
|
105
|
-
| screen | <i class="pf-icon pf-icon-screen"></i> | <i class="pf-icon pf-icon-screen"></i>
|
|
106
|
-
| security | <i class="pf-icon pf-icon-security"></i> | <i class="pf-icon pf-icon-security"></i>
|
|
107
|
-
| server-group | <i class="pf-icon pf-icon-server-group"></i> | <i class="pf-icon pf-icon-server-group"></i>
|
|
108
|
-
| server | <i class="pf-icon pf-icon-server"></i> | <i class="pf-icon pf-icon-server"></i>
|
|
109
|
-
| service-catalog | <i class="pf-icon pf-icon-service-catalog"></i> | <i class="pf-icon pf-icon-service-catalog"></i>
|
|
110
|
-
| service | <i class="pf-icon pf-icon-service"></i> | <i class="pf-icon pf-icon-service"></i>
|
|
111
|
-
| services | <i class="pf-icon pf-icon-services"></i> | <i class="pf-icon pf-icon-services"></i>
|
|
112
|
-
| spinner | <i class="pf-icon pf-icon-spinner"></i> | <i class="pf-icon pf-icon-spinner"></i>
|
|
113
|
-
| spinner2 | <i class="pf-icon pf-icon-spinner2"></i> | <i class="pf-icon pf-icon-spinner2"></i>
|
|
114
|
-
| storage-domain | <i class="pf-icon pf-icon-storage-domain"></i> | <i class="pf-icon pf-icon-storage-domain"></i>
|
|
115
|
-
| task | <i class="pf-icon pf-icon-task"></i> | <i class="pf-icon pf-icon-task"></i>
|
|
116
|
-
| tenant | <i class="pf-icon pf-icon-tenant"></i> | <i class="pf-icon pf-icon-tenant"></i>
|
|
117
|
-
| thumb-tack | <i class="pf-icon pf-icon-thumb-tack"></i> | <i class="pf-icon pf-icon-thumb-tack"></i>
|
|
118
|
-
| topology | <i class="pf-icon pf-icon-topology"></i> | <i class="pf-icon pf-icon-topology"></i>
|
|
119
|
-
| trend-down | <i class="pf-icon pf-icon-trend-down"></i> | <i class="pf-icon pf-icon-trend-down"></i>
|
|
120
|
-
| trend-up | <i class="pf-icon pf-icon-trend-up"></i> | <i class="pf-icon pf-icon-trend-up"></i>
|
|
121
|
-
| unknown | <i class="pf-icon pf-icon-unknown"></i> | <i class="pf-icon pf-icon-unknown"></i>
|
|
122
|
-
| unlocked | <i class="pf-icon pf-icon-unlocked"></i> | <i class="pf-icon pf-icon-unlocked"></i>
|
|
123
|
-
| unplugged | <i class="pf-icon pf-icon-unplugged"></i> | <i class="pf-icon pf-icon-unplugged"></i>
|
|
124
|
-
| user | <i class="pf-icon pf-icon-user"></i> | <i class="pf-icon pf-icon-user"></i>
|
|
125
|
-
| users | <i class="pf-icon pf-icon-users"></i> | <i class="pf-icon pf-icon-users"></i>
|
|
126
|
-
| virtual-machine | <i class="pf-icon pf-icon-virtual-machine"></i> | <i class="pf-icon pf-icon-virtual-machine"></i>
|
|
127
|
-
| volume | <i class="pf-icon pf-icon-volume"></i> | <i class="pf-icon pf-icon-volume"></i>
|
|
128
|
-
| warning-triangle | <i class="pf-icon pf-icon-warning-triangle"></i> | <i class="pf-icon pf-icon-warning-triangle"></i>
|
|
129
|
-
| zone | <i class="pf-icon pf-icon-zone"></i> | <i class="pf-icon pf-icon-zone"></i>
|
package/docs/pages/index.js
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
import { PageSection } from '@patternfly/react-core';
|
|
3
|
-
import quickRefPdf from './reference-docs/PF-quick-ref.pdf';
|
|
4
|
-
|
|
5
|
-
const HomePage = () => (
|
|
6
|
-
<PageSection variant="light">
|
|
7
|
-
Just getting started? Take a look at the <a href="/contribution">Contribution guide</a> and{' '}
|
|
8
|
-
<a href="/guidelines">Coding guidelines.</a> Always keep our <a href="/accessibility-guide">Accessibility guide</a>{' '}
|
|
9
|
-
in mind. Download a <a href={quickRefPdf}>quick reference sheet.</a>
|
|
10
|
-
</PageSection>
|
|
11
|
-
);
|
|
12
|
-
|
|
13
|
-
export default HomePage;
|
|
Binary file
|
|
Binary file
|
|
@@ -1,188 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
id: upgrade-guide
|
|
3
|
-
title: Upgrading to PatternFly 4
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
Use the following steps to upgrade from PatternFly 3 to PatternFly 4.
|
|
7
|
-
|
|
8
|
-
**Before you begin**
|
|
9
|
-
|
|
10
|
-
- **Does you application require IE11 support?**
|
|
11
|
-
- If the answer is yes, you can't upgrade to PatternFly 4. We're sorry!
|
|
12
|
-
- **Do you know what your build process is?**
|
|
13
|
-
- Steps and requirements differ for basic HTML, Gulp, and Webpack, so be prepared with that information going in.
|
|
14
|
-
- **Do you need to run PatternFly 3 and PatternFly 4 together?**
|
|
15
|
-
- If the answer is yes, use the following steps to update your configuration in the `src/patternfly/sass-utilities/scss-variables.scss` file to state `false`:
|
|
16
|
-
|
|
17
|
-
```scss
|
|
18
|
-
$pf-global--enable-reset: false !default;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
## Installing PatternFly 4
|
|
23
|
-
|
|
24
|
-
Run the following commands to install:
|
|
25
|
-
|
|
26
|
-
```bash
|
|
27
|
-
npm install @patternfly/patternfly
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
----
|
|
31
|
-
|
|
32
|
-
## Configure your project
|
|
33
|
-
|
|
34
|
-
1. Navigate to the @patternfly/patternfly package you just installed and find the PatternFly 4 CSS stylesheet, `patternfly.css`. This file contains all of the updated PatternFly 4 styles.
|
|
35
|
-
2. Copy `patternfly.css` to your project's CSS directory.
|
|
36
|
-
3. In your HTML file, add the following line to the bottom of your list of CSS files to link to your new stylesheet:
|
|
37
|
-
|
|
38
|
-
```html noLive
|
|
39
|
-
<link rel="stylesheet" href="css/patternfly.css">
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
This will make it so that PatternFly 4 styles take precedence over anything that currently resides in your application.
|
|
43
|
-
|
|
44
|
-
## Building PatternFly 4
|
|
45
|
-
|
|
46
|
-
PatternFly 4 is distributed as separated modules:
|
|
47
|
-
|
|
48
|
-
- **Layouts** allow you to structure and organize the content on your pages
|
|
49
|
-
- **Components**, like buttons and alerts, can be assembled together to build applications
|
|
50
|
-
|
|
51
|
-
Each module delivers a sass file (`scss`) and CSS file so you can either include them in your build environment or consume the CSS from your page header.
|
|
52
|
-
|
|
53
|
-
- _If you need to overwrite any elements, we recommend extending the variables found in the `.scss` files, rather than manually overwriting the CSS._
|
|
54
|
-
|
|
55
|
-
All of PatternFly 4's components are kept under `@patternfly/patternfly/components/`.
|
|
56
|
-
|
|
57
|
-
All of PatternFly 4's layouts are kept under `@patternfly/patternfly/layouts/`.
|
|
58
|
-
|
|
59
|
-
### Build Examples
|
|
60
|
-
|
|
61
|
-
#### Webpack
|
|
62
|
-
|
|
63
|
-
_This example uses the following configuration:_
|
|
64
|
-
|
|
65
|
-
```json
|
|
66
|
-
webpack: "3.8.1",
|
|
67
|
-
sass-loader: "7.0.0",
|
|
68
|
-
css-loader: "^0.28.11",
|
|
69
|
-
style-loader: "^0.21.0",
|
|
70
|
-
sass: "^1.34.0"
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
_Code Snippets_
|
|
74
|
-
|
|
75
|
-
- Import all `.scss` files
|
|
76
|
-
|
|
77
|
-
```js noLive
|
|
78
|
-
module.exports = {
|
|
79
|
-
module: {
|
|
80
|
-
rules: [{
|
|
81
|
-
test: /\.scss$/,
|
|
82
|
-
use: [{
|
|
83
|
-
loader: "style-loader"
|
|
84
|
-
}, {
|
|
85
|
-
loader: "css-loader"
|
|
86
|
-
}, {
|
|
87
|
-
loader: "sass-loader",
|
|
88
|
-
options: {
|
|
89
|
-
includePaths: [
|
|
90
|
-
"../node_modules/@patternfly/patternfly/"
|
|
91
|
-
]
|
|
92
|
-
}
|
|
93
|
-
}]
|
|
94
|
-
}]
|
|
95
|
-
}
|
|
96
|
-
};
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
- Import select modules
|
|
100
|
-
|
|
101
|
-
```js noLive
|
|
102
|
-
module.exports = {
|
|
103
|
-
module: {
|
|
104
|
-
rules: [{
|
|
105
|
-
test: /\.scss$/,
|
|
106
|
-
use: [{
|
|
107
|
-
loader: "style-loader"
|
|
108
|
-
}, {
|
|
109
|
-
loader: "css-loader"
|
|
110
|
-
}, {
|
|
111
|
-
loader: "sass-loader",
|
|
112
|
-
options: {
|
|
113
|
-
includePaths: [
|
|
114
|
-
"../node_modules/@patternfly/patternfly/layouts/Page/",
|
|
115
|
-
"../node_modules/@patternfly/patternfly/layouts/Grid",
|
|
116
|
-
"../node_modules/@patternfly/patternfly/components/Content",
|
|
117
|
-
"../node_modules/@patternfly/patternfly/components/SecondaryNav",
|
|
118
|
-
"../node_modules/@patternfly/patternfly/components/Button"
|
|
119
|
-
]
|
|
120
|
-
}
|
|
121
|
-
}]
|
|
122
|
-
}]
|
|
123
|
-
}
|
|
124
|
-
};
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
----
|
|
128
|
-
|
|
129
|
-
## Typography
|
|
130
|
-
|
|
131
|
-
With PatternFly 4, we are switching from the Open Sans font family to Overpass. Additionally, we are updating the base font size from `12px` to `16px`, in order to increase readability and accessibility.
|
|
132
|
-
|
|
133
|
-
Overpass can be utilized in two different ways:
|
|
134
|
-
|
|
135
|
-
1. Built into PatternFly 4
|
|
136
|
-
- By default, we include Overpass as part of the PatternFly 4 distributed CSS file. You do not need to do anything with your configuration to use this new font family.
|
|
137
|
-
1. Used as a CDN
|
|
138
|
-
- If you wish to use the CDN for Overpass rather than the default approach, you will need to update the `sass-utilities/scss-variables.scss` file and build PatternFly 4 as part of your build process.
|
|
139
|
-
- To use the CDN vs the standard build, update the `sass-utilities/scss-variables.scss` file as follows:
|
|
140
|
-
|
|
141
|
-
```scss
|
|
142
|
-
$pf-global--enable-font-overpass-cdn: true !default;
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
## Icons
|
|
146
|
-
|
|
147
|
-
### PatternFly icons
|
|
148
|
-
|
|
149
|
-
TBD
|
|
150
|
-
|
|
151
|
-
### Font Awesome 5
|
|
152
|
-
|
|
153
|
-
Font Awesome 5 is now part of PatternFly 4, and we give you options for utilizing this icon library.
|
|
154
|
-
|
|
155
|
-
#### Font Awesome 5 packaged vs CDN
|
|
156
|
-
|
|
157
|
-
As part of PatternFly 4, we give users the option to either use Font Awesome 5 as an included set (prebuilt into the CSS), or as a CDN reference.
|
|
158
|
-
|
|
159
|
-
If you wish to use the CDN, you will need to build PatternFly 4 from source (`node_modules/@patternfly/patternfly/`) and update the `sass-utilities/scss-variables.scss` file as follows:
|
|
160
|
-
|
|
161
|
-
```scss
|
|
162
|
-
$pf-global--enable-fontawesome-cdn: true !default;
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
#### Font Awesome 4 & 5
|
|
166
|
-
|
|
167
|
-
If you are currently using Font Awesome 4 and just want to use Font Awesome 5 immediately, you will need to add the Font Awesome scripts:
|
|
168
|
-
|
|
169
|
-
```html noLive
|
|
170
|
-
<script defer src="https://use.fontawesome.com/releases/[VERSION]/js/all.js"></script>
|
|
171
|
-
<script defer src="https://use.fontawesome.com/releases/[VERSION]/js/v4-shims.js"></script>
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
This replaces the bundled Font Awesome 5 files in PatternFly 4, so your configuration file (`sass-utilities/scss-variables.scss`) will need to be updated to remove Font Awesome 5.
|
|
175
|
-
|
|
176
|
-
```scss
|
|
177
|
-
$pf-global--disable-fontawesome: true !default;
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
#### Font Awesome 5 tree shaking
|
|
181
|
-
|
|
182
|
-
Additionally, Font Awesome 5 now provides the option for [tree shaking](https://fontawesome.com/how-to-use/use-with-node-js#tree-shaking). In order to utilize this option, you will need to build PatternFly 4 from source (`node_modules/@patternfly/patternfly/`), and update the `sass-utilities/scss-variables.scss` file accordingly.
|
|
183
|
-
|
|
184
|
-
The updated `scss-variables.scss` file should look as follows:
|
|
185
|
-
|
|
186
|
-
```scss
|
|
187
|
-
$pf-global--disable-fontawesome: true !default;
|
|
188
|
-
```
|