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
Copy file name to clipboardExpand all lines: CHANGELOG-1.x.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,5 +14,6 @@
14
14
-[6eadb21](https://github.com/patternfly/patternfly-elements/commit/6eadb21a29768c06ff312de42bd54b44072ee051) fix: umd.min modules now import umd.min builds of PFE dependencies (#1168)
15
15
-[40e0b09](https://github.com/patternfly/patternfly-elements/commit/40e0b099e77943feee4e8ba1a34d25b01ddf86ff) fix: global theme palette color for visited links in a saturated context
16
16
-[117a0e7](https://github.com/patternfly/patternfly-elements/commit/117a0e7e407ea1244cc861b251391f61a8b143ef) fix: Variable references to theme vs. context
17
-
-[7c7093a1](https://github.com/patternfly/patternfly-elements/commit/7c7093a1b4d099941320558e54003a0beca01eda) fix: ie11 pfe-cta link text and padding issues
18
-
-[](https://github.com/patternfly/patternfly-elements/commit/) feat: Add theming to storybook
17
+
-[a02d6e5](https://github.com/patternfly/patternfly-elements/commit/a02d6e57f9e444b28cde9676d70c0e16a5dca4d9) fix: ie11 pfe-cta link text and padding issues
Copy file name to clipboardExpand all lines: elements/pfe-band/README.md
+32-21Lines changed: 32 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ All slots other than `pfe-band--body` are optional. If the slot is not defined,
8
8
9
9
-`pfe-band--header`: This slot renders at the top of the container and generally contains the title, headline, and/or subheadline content. Other possible candidates include a set of social sharing links or tags that describe the content below. The template is automatically wrapping this slot in a `header` tag. Recommend using h-level or p tags inside this slot.
10
10
-**Default slot**: This unnamed slot should contain the bulk of the content in this element. The template is automatically wrapping all content within an `article` tag.
11
-
-`pfe-band--footer`: This slot is typically used for calls-to-action or footnotes and is pushed to the bottom of the container. Recommended tags include `pfe-cta`.The template is automatically wrapping this slot in a `footer` tag.
11
+
-`pfe-band--footer`: This slot is typically used for calls-to-action or footnotes and is pushed to the bottom of the container. Recommended tags include `pfe-cta`.The template is automatically wrapping this slot in a `footer` tag.
12
12
-`pfe-band--aside`: This slot is for content that should be rendered to the right or left of the default slot on desktop. Asides often contain `pfe-card` or interest forms which provide users a little more information or context for the band. The template is automatically wrapping this slot in an `aside` tag.
13
13
14
14
### Example markup
@@ -45,27 +45,43 @@ All slots other than `pfe-band--body` are optional. If the slot is not defined,
45
45
46
46
There are several attributes available for customizing the visual treatment of this container.
47
47
48
-
-`pfe-color`: Options include darkest, darker, accent, complement, lighter, lightest. The band has a default value of `#dfdfdf`. Your context will influence these colors so check there first if you are seeing inconsistencies.
48
+
-`color`: Options include darkest, darker, accent, complement, lighter, lightest. The band has a default value of `#dfdfdf`. Your context will influence these colors so check there first if you are seeing inconsistencies.
-`pfe-img-src`: Optional background image applied to the entire band container. Alignment of this image can be managed using the `--pfe-band--BackgroundPosition` variable which is set to `center center` by default.
61
-
-`pfe-size`: Optionally adjusts the padding on the container. Accepts: `small`.
60
+
-`img-src`: Optional background image applied to the entire band container. Alignment of this image can be managed using the `--pfe-band--BackgroundPosition` variable which is set to `center center` by default.
61
+
-`size`: Optionally adjusts the padding on the container. Accepts: `small`.
62
+
-`use-grid`: This turns on a default grid inside the header, body, footer, and aside regions. The grid can be customized using the following CSS variables:
The aside settings have defaults and if no attribute is defined on the element's main tag, these attributes will be injected with their default values automatically.
65
81
66
-
-`pfe-aside-desktop`: This influences where the aside is rendered at the desktop view and are indicated relative to the body content. Options are `right` or `left`. **Right is the default.**
67
-
-`pfe-aside-mobile`: This influences the position of the aside in the mobile view as well as where in the DOM the aside markup is rendered. These names are relative to the body content. Options are `top` or `bottom`. **Bottom is the default.**
68
-
-`pfe-aside-height`: This influences the height of the aside region relative to the body content. Options are `full` or `body`. A `full` height starts at the top of the band and spans the header, body, and footer regions. A `body` height spans the body and footer regions only with the header region sitting above it in the rendered view. **Body is the default.**
82
+
-`aside-desktop`: This influences where the aside is rendered at the desktop view and are indicated relative to the body content. Options are `right` or `left`. **Right is the default.**
83
+
-`aside-mobile`: This influences the position of the aside in the mobile view as well as where in the DOM the aside markup is rendered. These names are relative to the body content. Options are `top` or `bottom`. **Bottom is the default.**
84
+
-`aside-height`: This influences the height of the aside region relative to the body content. Options are `full` or `body`. A `full` height starts at the top of the band and spans the header, body, and footer regions. A `body` height spans the body and footer regions only with the header region sitting above it in the rendered view. **Body is the default.**
69
85
70
86
## Variables
71
87
There are several powerful variables available to hook into and override default styles.
@@ -74,12 +90,7 @@ There are several powerful variables available to hook into and override default
74
90
-**Background color**: Though using the `pfe-color` attribute is strongly recommended when setting the background color for the band, you can also use completely custom colors by updating the `--pfe-band--BackgroundColor` variable. If you update this value manually, you should also update the `--context` context variable to invoke the right context on it and it's child elements. Supported contexts include: `light`, `dark`, and `saturated`.
75
91
-**Background position**: This is designed for use with the `pfe-img-src` attribute to allow you to align your background image. Default value is `center center`.
76
92
-**Border**: This allows the customization of a border around the entire container and is primarily designed to be used to add a top and/or bottom border line. This variable accepts the entire border shorthand and is set to transparent by default.
77
-
-**Layout**: The band has a rudimentary layout system designed to be used inside the slot regions for the header, body, footer, and aside. It uses the CSS grid spec and creates a stacked layout by default. By updating these values, you will be able to create simple grid layouts. Please note that these do not include fallbacks for older browsers. Possible values include: `1fr 1fr`, `repeat(3, 1fr)`, `repeat(auto-fill, minmax(300px, 1fr))`
78
-
*`--pfe-band--layout`: Applied to `.pfe-band__container`.
79
-
*`--pfe-band_header--layout`: Applied to `.pfe-band__header`.
80
-
*`--pfe-band_body--layout`: Applied to `.pfe-band__body`.
81
-
*`--pfe-band_footer--layout`: Applied to `.pfe-band__footer`.
82
-
*`--pfe-band_aside--layout`: Applied to `.pfe-band__aside`.
93
+
-**Layout**: The band has a rudimentary layout system designed to be used inside the slot regions for the header, body, footer, and aside (see `use-grid` attribute details above). The regions themselves are also wrapped in a grid system that supports customization. All layouts appears "stacked" by default. Please note that the fallback for older browsers is a simple stacked layout (the aside position will be aligned using floats). Possible values include: `1fr 1fr`, `repeat(3, 1fr)`, `repeat(auto-fill, minmax(300px, 1fr))`. i.e., `--pfe-band--layout: repeat(auto-fill, minmax(300px, 1fr));`.
83
94
84
95
## Test
85
96
@@ -89,11 +100,11 @@ There are several powerful variables available to hook into and override default
0 commit comments