Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DS-811 Wrapper Element #2522

Merged
merged 11 commits into from
Aug 10, 2022
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{% set usage %}{% verbatim %}
{% include '@bolt-elements-wrapper/wrapper.twig' with {
content: 'This is a wrapper'
} only %}
{% endverbatim %}{% endset %}

{% include '@utils/docs.twig' with {
componentName: 'wrapper',
componentGroup: 'elements',
usage: usage
} only %}

Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
{% set description %}
A wrapper has no semantic meaning. It simply holds visual elements and content on the page.
{% endset %}

{% set notes %}
<bolt-ol>
<bolt-li>The wrapper <code>max-width</code> is 1400px. The width and a space on the sides adjusts to the smaller device screen. Content or visual elements added inside the wrapper don't overflow the imposed width of 1400px.</bolt-li>
<bolt-li>In the use case when you need another maximum width use the <code>attributes</code> prop and add inline style.</bolt-li>
</bolt-ol>
{% endset %}

{% set demo %}
<div class="u-bolt-margin-bottom-xlarge">
{% include '@bolt-elements-wrapper/wrapper.twig' with {
content: '<p>An example of a text added inside the wrapper.</p>
<p>Chicken bacon doner pancetta pork corned beef, swine jowl burgdoggen pastrami buffalo beef ribs shankle. Turducken pork porchetta shankle, salami short ribs corned beef. Short ribs turkey burgdoggen, fatback jerky chuck landjaeger corned beef pork t-bone jowl hamburger brisket strip steak. Tenderloin cow bacon cupim t-bone short ribs swine biltong beef ribs capicola sausage beef. Chicken bacon doner pancetta pork corned beef, swine jowl burgdoggen pastrami buffalo beef ribs shankle. Turducken pork porchetta shankle, salami short ribs corned beef. Short ribs turkey burgdoggen, fatback jerky chuck landjaeger corned beef pork t-bone jowl hamburger brisket strip steak. Tenderloin cow bacon cupim t-bone short ribs swine biltong beef ribs capicola sausage beef. Short ribs turkey burgdoggen, fatback jerky chuck landjaeger corned beef pork t-bone jowl hamburger brisket strip steak. Tenderloin cow bacon cupim t-bone short ribs swine biltong beef ribs capicola sausage beef.</p>'
} only %}
</div>

{% set image %}
<p>An example of an image added inside the wrapper.</p>
{% include '@bolt-elements-image/image.twig' with {
fill: true,
attributes: {
alt: 'Alt text.',
src: 'https://via.placeholder.com/800x450',
srcset: 'https://via.placeholder.com/400x225 400w, https://via.placeholder.com/800x450 800w',
sizes: '96vw',
width: 800,
height: 450,
},
} only %}
{% endset %}

<div class="u-bolt-margin-bottom-xlarge">
{% include '@bolt-elements-wrapper/wrapper.twig' with {
content: image
} only %}
</div>

{% set item_aside %}
{% include '@bolt-components-placeholder/placeholder.twig' with {
text: 'Aside',
} only %}
{% endset %}

{% set item_main %}
{% include '@bolt-components-placeholder/placeholder.twig' with {
text: 'Main',
} only %}
{% endset %}
{% set grid %}
<p>An example of a grid added inside the wrapper.</p>
{% include '@bolt-components-grid/grid.twig' with {
items: [
{
column_start: '1',
column_span: '12 8@xsmall',
content: item_main,
},
{
column_start: '1 9@xsmall',
column_span: '12 4@xsmall',
content: item_aside,
},
]
} only %}
{% endset %}
{% include '@bolt-elements-wrapper/wrapper.twig' with {
content: grid
} only %}
{% endset %}


{% set twig_markup %}{% verbatim %}
{% set image %}
{% include '@bolt-elements-image/image.twig' with {
fill: true,
attributes: {
alt: 'Alt text.',
src: 'path/image-800.jpg',
srcset: 'path/image-400.jpg 400w, path/image-800.jpg 800w',
sizes: '96vw',
width: 800,
height: 450,
},
} only %}
{% endset %}
{% include '@bolt-elements-wrapper/wrapper.twig' with {
content: image
} only %}
{% endverbatim %}{% endset %}

{% set html_markup %}
{% verbatim %}
<div class="e-bolt-wrapper">
<img alt="Alt text." src="path/image-800.jpg" srcset="path/image-400.jpg 400w, path/image-800.jpg 800w" sizes="96vw" width=800 height=450
class="e-bolt-image e-bolt-image--fill">
</div>
{% endverbatim %}
{% endset %}

{% include '@utils/pattern-doc-page.twig' with {
title: 'Wrapper',
description: description,
notes: notes,
demo: demo,
twig_markup: twig_markup,
html_markup: html_markup
} only %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{% set description %}
Whenever custom maximum width is needed use <code>attributes</code> prop and add <code>max-width</code> as an inline style.
{% endset %}

{% set notes %}
Please rememeber to add <code>max-width</code>, not <code>width</code>, to the style. It's neccessery to prevent overflowing the content.
{% endset %}

{% set demo %}
{% include '@bolt-elements-wrapper/wrapper.twig' with {
content: '<p>An example of a text added inside the wrapper with the custom <code>max-width</code> of 700px.</p>
<p>Chicken bacon doner pancetta pork corned beef, swine jowl burgdoggen pastrami buffalo beef ribs shankle. Turducken pork porchetta shankle, salami short ribs corned beef. Short ribs turkey burgdoggen, fatback jerky chuck landjaeger corned beef pork t-bone jowl hamburger brisket strip steak. Tenderloin cow bacon cupim t-bone short ribs swine biltong beef ribs capicola sausage beef. Chicken bacon doner pancetta pork corned beef, swine jowl burgdoggen pastrami buffalo beef ribs shankle. Turducken pork porchetta shankle, salami short ribs corned beef. Short ribs turkey burgdoggen, fatback jerky chuck landjaeger corned beef pork t-bone jowl hamburger brisket strip steak. Tenderloin cow bacon cupim t-bone short ribs swine biltong beef ribs capicola sausage beef. Short ribs turkey burgdoggen, fatback jerky chuck landjaeger corned beef pork t-bone jowl hamburger brisket strip steak. Tenderloin cow bacon cupim t-bone short ribs swine biltong beef ribs capicola sausage beef.</p>',
attributes: {
style: [
'max-width: 700px;'
]
}
} only %}
{% endset %}

{% set twig_markup %}{% verbatim %}
{% include '@bolt-elements-wrapper/wrapper.twig' with {
content: 'Chicken bacon doner pancetta pork corned beef, swine jowl burgdoggen pastrami buffalo beef ribs shankle. Turducken pork porchetta shankle, salami short ribs corned beef. Short ribs turkey burgdoggen, fatback jerky chuck landjaeger corned beef pork t-bone jowl hamburger brisket strip steak. Tenderloin cow bacon cupim t-bone short ribs swine biltong beef ribs capicola sausage beef. Chicken bacon doner pancetta pork corned beef, swine jowl burgdoggen pastrami buffalo beef ribs shankle. Turducken pork porchetta shankle, salami short ribs corned beef. Short ribs turkey burgdoggen, fatback jerky chuck landjaeger corned beef pork t-bone jowl hamburger brisket strip steak. Tenderloin cow bacon cupim t-bone short ribs swine biltong beef ribs capicola sausage beef. Short ribs turkey burgdoggen, fatback jerky chuck landjaeger corned beef pork t-bone jowl hamburger brisket strip steak. Tenderloin cow bacon cupim t-bone short ribs swine biltong beef ribs capicola sausage beef.',
attributes: {
style: [
'max-width: 700px;'
]
}
} only %}
{% endverbatim %}{% endset %}

{% set html_markup %}
{% verbatim %}
<div class="e-bolt-wrapper" style="max-width: 700px;">
<p>Chicken bacon doner pancetta pork corned beef, swine jowl burgdoggen pastrami buffalo beef ribs shankle. Turducken pork porchetta shankle, salami short ribs corned beef. Short ribs turkey burgdoggen, fatback jerky chuck landjaeger corned beef pork t-bone jowl hamburger brisket strip steak. Tenderloin cow bacon cupim t-bone short ribs swine biltong beef ribs capicola sausage beef. Chicken bacon doner pancetta pork corned beef, swine jowl burgdoggen pastrami buffalo beef ribs shankle. Turducken pork porchetta shankle, salami short ribs corned beef. Short ribs turkey burgdoggen, fatback jerky chuck landjaeger corned beef pork t-bone jowl hamburger brisket strip steak. Tenderloin cow bacon cupim t-bone short ribs swine biltong beef ribs capicola sausage beef. Short ribs turkey burgdoggen, fatback jerky chuck landjaeger corned beef pork t-bone jowl hamburger brisket strip steak. Tenderloin cow bacon cupim t-bone short ribs swine biltong beef ribs capicola sausage beef.</p>
</div>
{% endverbatim %}
{% endset %}

{% include '@utils/pattern-doc-page.twig' with {
title: 'Wrapper Custom Maximum Width',
description: description,
notes: notes,
demo: demo,
twig_markup: twig_markup,
html_markup: html_markup
} only %}
1 change: 1 addition & 0 deletions packages/base-starter-kit/.boltrc.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
module.exports = {
components: {
global: [
'@bolt/elements-wrapper',
'@bolt/components-dialog',
'@bolt/elements-ratio',
'@bolt/core-v3.x',
Expand Down
1 change: 1 addition & 0 deletions packages/base-starter-kit/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
"@bolt/elements-ratio": "^5.5.0",
"@bolt/elements-text-link": "^5.5.0",
"@bolt/elements-type": "^5.5.0",
"@bolt/elements-wrapper": "^5.5.0",
"@bolt/global": "^5.5.0",
"@bolt/layouts-holy-grail": "^5.5.0",
"@bolt/layouts-layout": "^5.5.0",
Expand Down