From: XhmikosR Date: Sat, 24 Dec 2022 16:43:04 +0000 (+0200) Subject: Add v5.3.0-alpha1 docs (#37662) X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3041a4f1fdf133ed69b38b214683a99d18777716;p=thirdparty%2Fbootstrap.git Add v5.3.0-alpha1 docs (#37662) --- diff --git a/404.html b/404.html index bd9f8dd8cb..4757fc6131 100644 --- a/404.html +++ b/404.html @@ -1,34 +1,34 @@ - + - + - + -404 - File not found · Bootstrap v5.2 +404 - File not found · Bootstrap v5.3 - + - + - + - - - - - - + + + + + + @@ -36,7 +36,7 @@ - + @@ -45,7 +45,7 @@ - + @@ -84,12 +84,14 @@ - Check + + + @@ -119,6 +121,10 @@ + + + + @@ -129,6 +135,9 @@ + + + @@ -141,7 +150,7 @@ -
+
+ +
+ +
+
+
+

مثال الألبوم

+

وصف قصير حول الألبوم أدناه (محتوياته ، ومنشؤه ، وما إلى ذلك). اجعله قصير ولطيف، ولكن ليست قصير جدًا حتى لا يتخطى الناس هذا الألبوم تمامًا.

+

+ الدعوة الرئيسية للعمل + عمل ثانوي +

+
+
+
+ +
+
+ +
+
+
+ Placeholderصورة مصغرة +
+

هذه بطاقة أوسع مع نص داعم أدناه كمقدمة طبيعية لمحتوى إضافي. هذا المحتوى أطول قليلاً.

+
+
+ + +
+ 9 دقائق +
+
+
+
+
+
+ Placeholderصورة مصغرة +
+

هذه بطاقة أوسع مع نص داعم أدناه كمقدمة طبيعية لمحتوى إضافي. هذا المحتوى أطول قليلاً.

+
+
+ + +
+ 9 دقائق +
+
+
+
+
+
+ Placeholderصورة مصغرة +
+

هذه بطاقة أوسع مع نص داعم أدناه كمقدمة طبيعية لمحتوى إضافي. هذا المحتوى أطول قليلاً.

+
+
+ + +
+ 9 دقائق +
+
+
+
+ +
+
+ Placeholderصورة مصغرة +
+

هذه بطاقة أوسع مع نص داعم أدناه كمقدمة طبيعية لمحتوى إضافي. هذا المحتوى أطول قليلاً.

+
+
+ + +
+ 9 دقائق +
+
+
+
+
+
+ Placeholderصورة مصغرة +
+

هذه بطاقة أوسع مع نص داعم أدناه كمقدمة طبيعية لمحتوى إضافي. هذا المحتوى أطول قليلاً.

+
+
+ + +
+ 9 دقائق +
+
+
+
+
+
+ Placeholderصورة مصغرة +
+

هذه بطاقة أوسع مع نص داعم أدناه كمقدمة طبيعية لمحتوى إضافي. هذا المحتوى أطول قليلاً.

+
+
+ + +
+ 9 دقائق +
+
+
+
+ +
+
+ Placeholderصورة مصغرة +
+

هذه بطاقة أوسع مع نص داعم أدناه كمقدمة طبيعية لمحتوى إضافي. هذا المحتوى أطول قليلاً.

+
+
+ + +
+ 9 دقائق +
+
+
+
+
+
+ Placeholderصورة مصغرة +
+

هذه بطاقة أوسع مع نص داعم أدناه كمقدمة طبيعية لمحتوى إضافي. هذا المحتوى أطول قليلاً.

+
+
+ + +
+ 9 دقائق +
+
+
+
+
+
+ Placeholderصورة مصغرة +
+

هذه بطاقة أوسع مع نص داعم أدناه كمقدمة طبيعية لمحتوى إضافي. هذا المحتوى أطول قليلاً.

+
+
+ + +
+ 9 دقائق +
+
+
+
+
+
+
+ +
+ + + + + + + + + diff --git a/docs/5.3/examples/album/index.html b/docs/5.3/examples/album/index.html new file mode 100644 index 0000000000..8be2e45258 --- /dev/null +++ b/docs/5.3/examples/album/index.html @@ -0,0 +1,295 @@ + + + + + + + + + Album example · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ + + Album + + +
+
+
+ +
+ +
+
+
+

Album example

+

Something short and leading about the collection below—its contents, the creator, etc. Make it short and sweet, but not too short so folks don’t simply skip over it entirely.

+

+ Main call to action + Secondary action +

+
+
+
+ +
+
+ +
+
+
+ PlaceholderThumbnail +
+

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

+
+
+ + +
+ 9 mins +
+
+
+
+
+
+ PlaceholderThumbnail +
+

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

+
+
+ + +
+ 9 mins +
+
+
+
+
+
+ PlaceholderThumbnail +
+

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

+
+
+ + +
+ 9 mins +
+
+
+
+ +
+
+ PlaceholderThumbnail +
+

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

+
+
+ + +
+ 9 mins +
+
+
+
+
+
+ PlaceholderThumbnail +
+

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

+
+
+ + +
+ 9 mins +
+
+
+
+
+
+ PlaceholderThumbnail +
+

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

+
+
+ + +
+ 9 mins +
+
+
+
+ +
+
+ PlaceholderThumbnail +
+

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

+
+
+ + +
+ 9 mins +
+
+
+
+
+
+ PlaceholderThumbnail +
+

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

+
+
+ + +
+ 9 mins +
+
+
+
+
+
+ PlaceholderThumbnail +
+

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

+
+
+ + +
+ 9 mins +
+
+
+
+
+
+
+ +
+ + + + + + + + + diff --git a/docs/5.3/examples/blog-rtl/index.html b/docs/5.3/examples/blog-rtl/index.html new file mode 100644 index 0000000000..17e061b78e --- /dev/null +++ b/docs/5.3/examples/blog-rtl/index.html @@ -0,0 +1,290 @@ + + + + + + + + + قالب المدونة · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ الإشتراك في النشرة البريدية +
+
+ +
+
+ + بحث + + إنشاء حساب +
+
+
+ +
+ +
+
+ +
+
+
+

عنوان تدوينة مميزة أطول

+

عدة أسطر نصية متعددة تعبر عن التدوية، وذلك لإعلام القراء الجدد بسرعة وكفاءة حول أكثر الأشياء إثارة للاهتمام في محتويات هذه التدوينة.

+

أكمل القراءة...

+
+
+ +
+
+
+
+ العالم +

مشاركة مميزة

+
نوفمبر 12
+

هذه بطاقة أوسع مع نص داعم أدناه كمقدمة طبيعية لمحتوى إضافي.

+ أكمل القراءة +
+
+ Placeholderصورة مصغرة +
+
+
+
+
+
+ التصميم +

عنوان الوظيفة

+
نوفمبر 11
+

هذه بطاقة أوسع مع نص داعم أدناه كمقدمة طبيعية لمحتوى إضافي.

+ أكمل القراءة +
+
+ Placeholderصورة مصغرة +
+
+
+
+ +
+
+

+ من Firehose +

+ +
+

مثال على تدوينة

+

1 يناير 2021 بواسطة Mark

+ +

تعرض مشاركة المدونة هذه بضعة أنواع مختلفة من المحتوى الذي يتم دعمه وتصميمه باستخدام Bootstrap. النصوص الأساسية، الصور، والأكواد مدعومة بشكل كامل.

+
+

يشكِّل تأمين الغذاء في المستقبل قضية تؤرِّق حكومات العالَم والعلماء على حدٍّ سواء. فخلال القرن العشرين ازداد عدد سكان الأرض أربعة أضعاف، وتشير التقديرات إلى أن العدد سوف يصل إلى عشرة مليارات إنسان بحلول عام 2050م. وسوف تمثل هذه الزيادة الهائلة تحدياً كبيراً وضغطاً متصاعداً على قدرة الإنتاج الزراعي. الأمر الذي كان ولا بد من أن يدفع إلى تطوير تقنيات مبتكرة في تصنيع الغذاء غير الزراعة، منها تقنية مستقبلية تقوم على تصنيع الغذاء من الهواء.

+
+

تشغل الزراعة مساحات كبيرة من اليابسة، وتستهلك كميات هائلة من المياه، كما أن إنتاج الغذاء بواسطة الزراعة يسهم بنسبة عالية من انبعاثات غازات الاحتباس الحراري العالمية

+
+

تشغل الزراعة مساحات كبيرة من اليابسة، وتستهلك كميات هائلة من المياه. كما أن إنتاج الغذاء بواسطة الزراعة يسهم بنسبة عالية من انبعاثات غازات الاحتباس الحراري العالمية، وللمقارنة فإن هذه النسبة من الانبعاثات هي أكبر مما ينتجه قطاع النقل بكل ما فيه من سيارات وشاحنات وطائرات وقطارات.

+

عنوان

+

تحصل النباتات على غذائها بواسطة عملية تسمى البناء الضوئي، حيث تقوم النباتات بتحويل ضوء الشمس والماء وثاني أكسيد الكربون الموجود في الغلاف الجوي إلى غذاء وتطلق الأكسجين كمنتج ثانوي لهذا التفاعل الكيميائي. وتحدث هذه العملية في "البلاستيدات الخضراء". فالنباتات تستفيد من طاقة ضوء الشمس في تقسيم الماء إلى هيدروجين وأكسجين، وتحدث تفاعلات كيميائية أخرى ينتج عنها سكر الجلكوز الذي تستخدمه كمصدر للغذاء وينطلق الأكسجين من النباتات إلى الغلاف الجوي. وهذا يعني أن النباتات تحوِّل ثاني أكسيد الكربون إلى غذاء من خلال تفاعلات كيميائية معقَّدة. ويُعد البناء الضوئي من أهم التفاعلات الكيميائية على كوكب الأرض، فقد ساعد في الماضي على تطوُّر كوكبنا وظهور الحياة عليه. فالنباتات تستخدم ثاني أكسيد الكربون لصنع غذائها، وتطلق الأكسجين لتساعد الكائنات الأخرى على التنفس!

+

عنوان فرعي

+

ألهمت هذه العملية علماء وكالة الفضاء الأمريكية (ناسا) خلال الستينيات من القرن الماضي، لبحث فكرة إطعام روَّاد الفضاء في مهمات الفضاء الطويلة مثل السفر إلى المريخ. وكانت واحدة من الأفكار الواعدة تصنيع الغذاء عن طريق ثاني أكسيد الكربون الذي ينتجه روَّاد الفضاء، لكن ليس بواسطة النباتات بل عن طريق ميكروبات صغيرة وحيدة الخلية قادرة على حصد ثاني أكسيد الكربون لإنتاج كميات وفيرة من البروتين المغذي على شكل مسحوق عديم النكهة، كما يمكن استخدام المادة في صنع الأطعمة المألوفة لدينا.

+ 
Example code block
+

وخلافاً لما هو الحال في عالم النبات، فإن هذه الميكروبات لا تستخدم الضوء كما يحدث في عملية البناء الضوئي التي تستخدمها النباتات للحصول على الغذاء، أي لأنها قادرة على النمو في الظلام. تسمى هذه البكتريا "هيدروجينوتروف" (Hydrogenotrophs)، وهي تستخدم الهيدروجين كوقود لإنتاج الغذاء من ثاني أكسيد الكربون. فعندما يُنتج روَّاد الفضاء ثاني أكسيد الكربون، تلتقطه الميكروبات، ويتحوَّل مع مدخلات أخرى إلى غذاء غني بالكربون. وبهذه الطريقة سوف نحصل على دورة كربون مغلقة الحلقة.

+

عنوان فرعي

+

بعد مرور أكثر من نصف قرن على أبحاث ناسا، تعمل حالياً عدة شركات في قطاع البيولوجيا التركيبية من ضمنها إير بروتين (Air Protein) وسولار فودز (Solar Foods) على تطوير جيل جديد من المنتجات الغذائية المستدامة، من دون وجود بصمة كربونية. ولن تقتصر هذه المنتجات الغذائية على روَّاد الفضاء فحسب، بل سوف تمتد لتشمل جميع سكان الأرض، وسوف تُنتَج في فترة زمنية قصيرة، بدلاً من الشهور، ومن دون الاعتماد على الأراضي الزراعية. وهذا يعني الحصول على منتجات غذائية بشكل سريع جداً. كما سيصبح من الممكن تصنيع الغذاء بطريقة عمودية من خلال هذه الميكروبات، بدلاً من الطريقة الأفقية التقليدية الشبيهة بتقنية الزراعة العمودية الحديثة. وهذا يعني توفير منتجات غذائية أكبر من المساحة نفسها.

+

يتكوَّن الغذاء البشري من ثلاثة أنواع رئيسة، هي:

+
    +
  • البروتينات
    • +
  • الكربوهيدرات
    • +
  • الدهون
    • +
+

وتتكوَّن البروتينات من الأحماض الأمينية، وهي مجموعة من المركبات العضوية يبلغ عددها في جسم الإنسان عشرين حمضاً أمينياً، من بينها تسعة أساسية يحصل عليها الجسم من الغذاء. وتتكوَّن الأحماض الأمينية بشكل أساس من:

+
    +
  1. الكربون
    2. +
  2. الهيدروجين
    3. +
  3. الأكسجين
    4. +
  4. النيتروجين
    5. +
+

ومن الملاحظ أن النيتروجين يشكِّل نسبة %78 من الهواء، كما أن الهيدروجين نحصل عليه من خلال التحليل الكهربائي للماء، ومن الممكن نظرياً سحب الكربون من الهواء لتشكيل هذه الأحماض، ذلك أن الكربون هو العمود الفقري للأحماض الأمينية، كما أن الحياة على كوكب الأرض قائمة على الكربون لقدرته على تكوين سلاسل كربونية طويلة، وهذا ما تفعله الميكروبات بتصنيع أحماض أمينية من ثاني أكسيد الكربون من خلال مجموعة من التفاعلات الكيميائية المعقَّدة. وإضافة إلى صنع وجبات غنية بالبروتين، فهذه الميكروبات تنتج منتجات أخرى مثل الزيوت التي لها عديد من الاستخدامات.

+
+ +
+

تدوينة أخرى

+

23 ديسمبر 2020 بواسطة Jacob

+ +

في الوقت الحالي، تدرس عدَّة شركات هذه الميكروبات بشكل أعمق، وتستزرعها من أجل الحصول على الغذاء. ففي عام 2019م، أعلن باحثون في شركة (Air Protein) الأمريكية نجاحهم في تحويل ثاني أكسيد الكربون الموجود في الهواء إلى لحوم صناعية مصنوعة من البروتين، التي لا تتطلَّب أي أرض زراعية، بل هي معتمدة بشكل أساسي على الهواء.

+
+

تم تصنيع اللحوم بأنواع عديدة

+
+

إذ استخدم هؤلاء الباحثون الهواء والطاقة المتجدِّدة كمدخلات في عملية مشابهة للتخمير، لإنتاج بروتين يحتوي على الأحماض الأمينية التسعة الأساسية وغني بالفيتامينات والمعادن، كما أنه خالٍ من الهرمونات والمضادات الحيوية والمبيدات الحشرية ومبيدات الأعشاب.

+

وتم تصنيع اللحوم بأنواع عديدة بما فيها الدواجن والأبقار والمأكولات البحرية، من دون حصول انبعاثات كربونية، على عكس تربية الأبقار التي تسهم في انبعاث غاز الميثان أحد غازات الاحتباس الحراري.

+
+ +
+

ميزة جديدة

+

14 ديسمبر 2020 بواسطة Jacob

+ +

كما أن الشركة الفنلندية (Solar Foods) طوَّرت تقنية لإنتاج البروتين من الهواء، حيث تبدأ العملية بتقسيم الماء إلى مكوناته الهيدروجين والأكسجين عن طريق الكهرباء. فالهيدروجين يوفِّر الطاقة للبكتريا لتحويل ثاني أكسيد الكربون والنيتروجين الموجودين في الهواء إلى مادة عضوية غنية بالبروتين بشكل أكفأ من نمو النباتات باستخدام البناء الضوئي. وهذا البروتين يشبه دقيق القمح وقد أطلق عليه اسم "سولين" (Solein).

+

وتقوم الشركة حالياً بجمع البيانات حول المنتج الغذائي لتقديمه إلى الاتحاد الأوروبي بهدف الحصول على ترخيص غذائي، كما أنها تخطط لبدء الإنتاج التجاري في العام المقبل 2021م. وقد أوضحت الشركة أنها مهتمة بإنتاج أطعمة صديقة للبيئة من خلال استخدام المواد الأساسية: الكهرباء وثاني أكسيد الكربون، وهذه الأطعمة سوف تجنبنا الأثر السلبي البيئي للزراعة التقليدية الذي يشمل كل شيء من استخدام الأرض والمياه إلى الانبعاثات الناتجة من تسميد المحاصيل أو تربية الحيوانات.

+

وعلى هذا، فإن البروتينات المشتقة من الميكروبات سوف:

+
    +
  • توفر حلاً ممكناً في ظل زيادة الطلب العالمي المستقبلي على الغذاء
    • +
  • تتوسع مصانع الغذاء في المستقبل لتكون أكفأ وأكثر استدامة
    • +
  • تصبح قادرة على توفير الغذاء لروَّاد الفضاء في سفرهم إلى المريخ وجميع سكان كوكب الأرض في عام 2050م
    • +
+

فتخيّل أن الميكروبات ستكون مصانع المستقبل، وأن غذاء المستقبل سيكون مصنوعاً من الهواء! وأن عام 2050م سيكون مختلفاً تماماً عن عالمنا اليوم. فهو عالم من دون زراعة ولا تربية حيوانات من أجل الغذاء! قد يبدو ذلك خيالياً لكنه ليس مستحيلاً!

+
+ + + +
+ +
+
+
+

حول

+

أقبلت، فأقبلت معك الحياة بجميع صنوفها وألوانها: فالنبات ينبت، والأشجار تورق وتزهر، والهرة تموء، والقمري يسجع، والغنم يثغو، والبقر يخور، وكل أليف يدعو أليفه. كل شيء يشعر بالحياة وينسي هموم الحياة، ولا يذكر إلا سعادة الحياة، فإن كان الزمان جسدا فأنت روحه، وإن كان عمرا فأنت شبابه.

+
+ +
+

الأرشيف

+
    +
  1. مارس 2021
    2. +
  2. شباط 2021
    3. +
  3. يناير 2021
    4. +
  4. ديسمبر 2020
    5. +
  5. نوفمبر 2020
    6. +
  6. أكتوبر 2020
    7. +
  7. سبتمبر 2020
    8. +
  8. اغسطس 2020
    9. +
  9. يوليو 2020
    10. +
  10. يونيو 2020
    11. +
  11. مايو 2020
    12. +
  12. ابريل 2020
    13. +
+
+ +
+

في مكان آخر

+
    +
  1. GitHub
    2. +
  2. Twitter
    3. +
  3. Facebook
    4. +
+
+
+
+
+ +
+ + + + + + + diff --git a/docs/5.3/examples/blog/blog.css b/docs/5.3/examples/blog/blog.css new file mode 100644 index 0000000000..cc5fc7473a --- /dev/null +++ b/docs/5.3/examples/blog/blog.css @@ -0,0 +1,69 @@ +/* stylelint-disable selector-list-comma-newline-after */ + +.blog-header { + border-bottom: 1px solid #e5e5e5; +} + +.blog-header-logo { + font-family: "Playfair Display", Georgia, "Times New Roman", serif/*rtl:Amiri, Georgia, "Times New Roman", serif*/; + font-size: 2.25rem; +} + +.blog-header-logo:hover { + text-decoration: none; +} + +h1, h2, h3, h4, h5, h6 { + font-family: "Playfair Display", Georgia, "Times New Roman", serif/*rtl:Amiri, Georgia, "Times New Roman", serif*/; +} + +.display-4 { + font-size: 2.5rem; +} +@media (min-width: 768px) { + .display-4 { + font-size: 3rem; + } +} + +.flex-auto { + flex: 0 0 auto; +} + +.h-250 { height: 250px; } +@media (min-width: 768px) { + .h-md-250 { height: 250px; } +} + +/* Pagination */ +.blog-pagination { + margin-bottom: 4rem; +} + +/* + * Blog posts + */ +.blog-post { + margin-bottom: 4rem; +} +.blog-post-title { + font-size: 2.5rem; +} +.blog-post-meta { + margin-bottom: 1.25rem; + color: #727272; +} + +/* + * Footer + */ +.blog-footer { + padding: 2.5rem 0; + color: #727272; + text-align: center; + background-color: #f9f9f9; + border-top: .05rem solid #e5e5e5; +} +.blog-footer p:last-child { + margin-bottom: 0; +} diff --git a/docs/5.3/examples/blog/blog.rtl.css b/docs/5.3/examples/blog/blog.rtl.css new file mode 100644 index 0000000000..fc03c35a31 --- /dev/null +++ b/docs/5.3/examples/blog/blog.rtl.css @@ -0,0 +1,69 @@ +/* stylelint-disable selector-list-comma-newline-after */ + +.blog-header { + border-bottom: 1px solid #e5e5e5; +} + +.blog-header-logo { + font-family: Amiri, Georgia, "Times New Roman", serif; + font-size: 2.25rem; +} + +.blog-header-logo:hover { + text-decoration: none; +} + +h1, h2, h3, h4, h5, h6 { + font-family: Amiri, Georgia, "Times New Roman", serif; +} + +.display-4 { + font-size: 2.5rem; +} +@media (min-width: 768px) { + .display-4 { + font-size: 3rem; + } +} + +.flex-auto { + flex: 0 0 auto; +} + +.h-250 { height: 250px; } +@media (min-width: 768px) { + .h-md-250 { height: 250px; } +} + +/* Pagination */ +.blog-pagination { + margin-bottom: 4rem; +} + +/* + * Blog posts + */ +.blog-post { + margin-bottom: 4rem; +} +.blog-post-title { + font-size: 2.5rem; +} +.blog-post-meta { + margin-bottom: 1.25rem; + color: #727272; +} + +/* + * Footer + */ +.blog-footer { + padding: 2.5rem 0; + color: #727272; + text-align: center; + background-color: #f9f9f9; + border-top: .05rem solid #e5e5e5; +} +.blog-footer p:last-child { + margin-bottom: 0; +} diff --git a/docs/5.3/examples/blog/index.html b/docs/5.3/examples/blog/index.html new file mode 100644 index 0000000000..06ed5a825e --- /dev/null +++ b/docs/5.3/examples/blog/index.html @@ -0,0 +1,343 @@ + + + + + + + + + Blog Template · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ Subscribe +
+
+ +
+
+ + Search + + Sign up +
+
+
+ +
+ +
+
+ +
+
+
+

Title of a longer featured blog post

+

Multiple lines of text that form the lede, informing new readers quickly and efficiently about what’s most interesting in this post’s contents.

+

Continue reading...

+
+
+ +
+
+
+
+ World +

Featured post

+
Nov 12
+

This is a wider card with supporting text below as a natural lead-in to additional content.

+ Continue reading +
+
+ PlaceholderThumbnail +
+
+
+
+
+
+ Design +

Post title

+
Nov 11
+

This is a wider card with supporting text below as a natural lead-in to additional content.

+ Continue reading +
+
+ PlaceholderThumbnail +
+
+
+
+ +
+
+

+ From the Firehose +

+ +
+

Sample blog post

+

January 1, 2021 by Mark

+ +

This blog post shows a few different types of content that’s supported and styled with Bootstrap. Basic typography, lists, tables, images, code, and more are all supported as expected.

+
+

This is some additional paragraph placeholder content. It has been written to fill the available space and show how a longer snippet of text affects the surrounding content. We'll repeat it often to keep the demonstration flowing, so be on the lookout for this exact same string of text.

+

Blockquotes

+

This is an example blockquote in action:

+
+

Quoted text goes here.

+
+

This is some additional paragraph placeholder content. It has been written to fill the available space and show how a longer snippet of text affects the surrounding content. We'll repeat it often to keep the demonstration flowing, so be on the lookout for this exact same string of text.

+

Example lists

+

This is some additional paragraph placeholder content. It's a slightly shorter version of the other highly repetitive body text used throughout. This is an example unordered list:

+
    +
  • First list item
    • +
  • Second list item with a longer description
    • +
  • Third list item to close it out
    • +
+

And this is an ordered list:

+
    +
  1. First list item
    2. +
  2. Second list item with a longer description
    3. +
  3. Third list item to close it out
    4. +
+

And this is a definition list:

+
+
HyperText Markup Language (HTML)
+
The language used to describe and define the content of a Web page
+
Cascading Style Sheets (CSS)
+
Used to describe the appearance of Web content
+
JavaScript (JS)
+
The programming language used to build advanced Web sites and applications
+
+

Inline HTML elements

+

HTML defines a long list of available inline tags, a complete list of which can be found on the Mozilla Developer Network.

+
    +
  • To bold text, use <strong>.
    • +
  • To italicize text, use <em>.
    • +
  • Abbreviations, like HTML should use <abbr>, with an optional title attribute for the full phrase.
    • +
  • Citations, like — Mark Otto, should use <cite>.
    • +
  • Deleted text should use <del> and inserted text should use <ins>.
    • +
  • Superscript text uses <sup> and subscript text uses <sub>.
    • +
+

Most of these elements are styled by browsers with few modifications on our part.

+

Heading

+

This is some additional paragraph placeholder content. It has been written to fill the available space and show how a longer snippet of text affects the surrounding content. We'll repeat it often to keep the demonstration flowing, so be on the lookout for this exact same string of text.

+

Sub-heading

+

This is some additional paragraph placeholder content. It has been written to fill the available space and show how a longer snippet of text affects the surrounding content. We'll repeat it often to keep the demonstration flowing, so be on the lookout for this exact same string of text.

+ 
Example code block
+

This is some additional paragraph placeholder content. It's a slightly shorter version of the other highly repetitive body text used throughout.

+
+ +
+

Another blog post

+

December 23, 2020 by Jacob

+ +

This is some additional paragraph placeholder content. It has been written to fill the available space and show how a longer snippet of text affects the surrounding content. We'll repeat it often to keep the demonstration flowing, so be on the lookout for this exact same string of text.

+
+

Longer quote goes here, maybe with some emphasized text in the middle of it.

+
+

This is some additional paragraph placeholder content. It has been written to fill the available space and show how a longer snippet of text affects the surrounding content. We'll repeat it often to keep the demonstration flowing, so be on the lookout for this exact same string of text.

+

Example table

+

And don't forget about tables in these posts:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameUpvotesDownvotes
Alice1011
Bob43
Charlie79
Totals2123
+ +

This is some additional paragraph placeholder content. It's a slightly shorter version of the other highly repetitive body text used throughout.

+
+ +
+

New feature

+

December 14, 2020 by Chris

+ +

This is some additional paragraph placeholder content. It has been written to fill the available space and show how a longer snippet of text affects the surrounding content. We'll repeat it often to keep the demonstration flowing, so be on the lookout for this exact same string of text.

+
    +
  • First list item
    • +
  • Second list item with a longer description
    • +
  • Third list item to close it out
    • +
+

This is some additional paragraph placeholder content. It's a slightly shorter version of the other highly repetitive body text used throughout.

+
+ + + +
+ +
+
+
+

About

+

Customize this section to tell your visitors a little bit about your publication, writers, content, or something else entirely. Totally up to you.

+
+ +
+

Archives

+
    +
  1. March 2021
    2. +
  2. February 2021
    3. +
  3. January 2021
    4. +
  4. December 2020
    5. +
  5. November 2020
    6. +
  6. October 2020
    7. +
  7. September 2020
    8. +
  8. August 2020
    9. +
  9. July 2020
    10. +
  10. June 2020
    11. +
  11. May 2020
    12. +
  12. April 2020
    13. +
+
+ +
+

Elsewhere

+
    +
  1. GitHub
    2. +
  2. Twitter
    3. +
  3. Facebook
    4. +
+
+
+
+
+ +
+ + + + + + + diff --git a/docs/5.3/examples/carousel-rtl/index.html b/docs/5.3/examples/carousel-rtl/index.html new file mode 100644 index 0000000000..1d9f2625a0 --- /dev/null +++ b/docs/5.3/examples/carousel-rtl/index.html @@ -0,0 +1,253 @@ + + + + + + + + + قالب شرائح العرض · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + +
+ + +
+
+ Placeholder140x140 +

عنوان

+

تذكر دائماً أن الحاسوب لا يمتلك ذكاءً، ولكنه يكتسب الذكاء الاصطناعي من خلال ثلاثة عناصر وظيفية رئيسة، هي: القدرة على التحليل، والقدرة على التأليف، والاستدلال المنطقي.

+

عرض التفاصيل

+
+
+ Placeholder140x140 +

عنوان آخر

+

إذا أردنا استخدام الحاسوب الذكي في معالجة اللغة العربية فإننا نجد أنفسنا أمام تحدٍّ كبير، خاصة وأن لغتنا تمتاز بتماسك منظوماتها وتداخلها، ومع ذلك فإن الذكاء الاصطناعي يمكّننا من الحصول على أربعة أنواع من المعالجة، هي: المعالجة الصوتية، والمعالجة الصرفية، والمعالجة النحوية، والمعالجة الدلالية.

+

عرض التفاصيل

+
+
+ Placeholder140x140 +

عنوان ثالث لتأكيد المعلومة

+

بفضل بحوث الذكاء الاصطناعي وتقنياته استطعنا الانتقال من مرحلة التعامل مع الفيزيائي إلى مرحلة التعامل مع المنطقي، وقد انعكس هذا الانتقال بصورة إيجابية على الكيفية التي تتعامل بها الشعوب مع لغاتها الحيَّة، وهذا يعني أنه يجب أن ينعكس بصورة إيجابية على كيفية تعاملنا مع لغتنا العربية.

+

عرض التفاصيل

+
+
+ + + + +
+ +
+
+

العنوان الأول المميز. سيذهل عقلك.

+

وجه الإنسان هو جزء معقَّد ومتميِّز للغاية من جسمه. وفي الواقع، إنه أحد أكثر أنظمة الإشارات المتاحة تعقيداً لدينا؛ فهو يتضمَّن أكثر من 40 عضلة مستقلة هيكلياً ووظيفياً، بحيث يمكن تشغيل كل منها بشكل مستقل عن البعض الآخر؛ وتشكِّل أحد أقوى مؤشرات العواطف.

+
+
+ Placeholder500x500 +
+
+ +
+ +
+
+

أوه نعم، هذا جيد. شاهد بنفسك.

+

عندما نضحك أو نبكي، فإننا نعرض عواطفنا، مما يسمح للآخرين بإلقاء نظرة خاطفة على أذهاننا أثناء "قراءة" وجوهنا بناءً على التغييرات في مكوّنات الوجه الرئيسة، مثل: العينين والحاجبين والجفنين والأنف والشفتين.

+
+
+ Placeholder500x500 +
+
+ +
+ +
+
+

وأخيرًا، هذا. كش ملك.

+

إن جميع العضلات في أجسامنا مدعمة بالأعصاب المتصلة من كافة أنحاء الجسم بالنخاع الشوكي والدماغ. وهذا الاتصال العصبي هو ثنائي الاتجاه، أي إن العصب يتسبَّب في تقلصات العضلات بناءً على إشارات الدماغ، ويقوم في الوقت نفسه بإرسال معلومات عن حالة العضلات إلى الدماغ

+
+
+ Placeholder500x500 +
+
+ +
+ + + +
+ + + + +
+ + + + + + + diff --git a/docs/5.3/examples/carousel/carousel.css b/docs/5.3/examples/carousel/carousel.css new file mode 100644 index 0000000000..0bdf9768d2 --- /dev/null +++ b/docs/5.3/examples/carousel/carousel.css @@ -0,0 +1,82 @@ +/* GLOBAL STYLES +-------------------------------------------------- */ +/* Padding below the footer and lighter body text */ + +body { + padding-top: 3rem; + padding-bottom: 3rem; + color: #5a5a5a; +} + + +/* CUSTOMIZE THE CAROUSEL +-------------------------------------------------- */ + +/* Carousel base class */ +.carousel { + margin-bottom: 4rem; +} +/* Since positioning the image, we need to help out the caption */ +.carousel-caption { + bottom: 3rem; + z-index: 10; +} + +/* Declare heights because of positioning of img element */ +.carousel-item { + height: 32rem; +} + + +/* MARKETING CONTENT +-------------------------------------------------- */ + +/* Center align the text within the three columns below the carousel */ +.marketing .col-lg-4 { + margin-bottom: 1.5rem; + text-align: center; +} +/* rtl:begin:ignore */ +.marketing .col-lg-4 p { + margin-right: .75rem; + margin-left: .75rem; +} +/* rtl:end:ignore */ + + +/* Featurettes +------------------------- */ + +.featurette-divider { + margin: 5rem 0; /* Space out the Bootstrap
more */ +} + +/* Thin out the marketing headings */ +/* rtl:begin:remove */ +.featurette-heading { + letter-spacing: -.05rem; +} + +/* rtl:end:remove */ + +/* RESPONSIVE CSS +-------------------------------------------------- */ + +@media (min-width: 40em) { + /* Bump up size of carousel content */ + .carousel-caption p { + margin-bottom: 1.25rem; + font-size: 1.25rem; + line-height: 1.4; + } + + .featurette-heading { + font-size: 50px; + } +} + +@media (min-width: 62em) { + .featurette-heading { + margin-top: 7rem; + } +} diff --git a/docs/5.3/examples/carousel/carousel.rtl.css b/docs/5.3/examples/carousel/carousel.rtl.css new file mode 100644 index 0000000000..d20a8111ab --- /dev/null +++ b/docs/5.3/examples/carousel/carousel.rtl.css @@ -0,0 +1,74 @@ +/* GLOBAL STYLES +-------------------------------------------------- */ +/* Padding below the footer and lighter body text */ + +body { + padding-top: 3rem; + padding-bottom: 3rem; + color: #5a5a5a; +} + + +/* CUSTOMIZE THE CAROUSEL +-------------------------------------------------- */ + +/* Carousel base class */ +.carousel { + margin-bottom: 4rem; +} +/* Since positioning the image, we need to help out the caption */ +.carousel-caption { + bottom: 3rem; + z-index: 10; +} + +/* Declare heights because of positioning of img element */ +.carousel-item { + height: 32rem; +} + + +/* MARKETING CONTENT +-------------------------------------------------- */ + +/* Center align the text within the three columns below the carousel */ +.marketing .col-lg-4 { + margin-bottom: 1.5rem; + text-align: center; +} +.marketing .col-lg-4 p { + margin-right: .75rem; + margin-left: .75rem; +} + + +/* Featurettes +------------------------- */ + +.featurette-divider { + margin: 5rem 0; /* Space out the Bootstrap
more */ +} + +/* Thin out the marketing headings */ + +/* RESPONSIVE CSS +-------------------------------------------------- */ + +@media (min-width: 40em) { + /* Bump up size of carousel content */ + .carousel-caption p { + margin-bottom: 1.25rem; + font-size: 1.25rem; + line-height: 1.4; + } + + .featurette-heading { + font-size: 50px; + } +} + +@media (min-width: 62em) { + .featurette-heading { + margin-top: 7rem; + } +} diff --git a/docs/5.3/examples/carousel/index.html b/docs/5.3/examples/carousel/index.html new file mode 100644 index 0000000000..90bfaa4f95 --- /dev/null +++ b/docs/5.3/examples/carousel/index.html @@ -0,0 +1,253 @@ + + + + + + + + + Carousel Template · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + +
+ + +
+
+ Placeholder140x140 +

Heading

+

Some representative placeholder content for the three columns of text below the carousel. This is the first column.

+

View details »

+
+
+ Placeholder140x140 +

Heading

+

Another exciting bit of representative placeholder content. This time, we've moved on to the second column.

+

View details »

+
+
+ Placeholder140x140 +

Heading

+

And lastly this, the third column of representative placeholder content.

+

View details »

+
+
+ + + + +
+ +
+
+

First featurette heading. It’ll blow your mind.

+

Some great placeholder content for the first featurette here. Imagine some exciting prose here.

+
+
+ Placeholder500x500 +
+
+ +
+ +
+
+

Oh yeah, it’s that good. See for yourself.

+

Another featurette? Of course. More placeholder content here to give you an idea of how this layout would work with some actual real-world content in place.

+
+
+ Placeholder500x500 +
+
+ +
+ +
+
+

And lastly, this one. Checkmate.

+

And yes, this is the last block of representative placeholder content. Again, not really intended to be actually read, simply here to give you a better view of what this would look like with some actual content. Your content.

+
+
+ Placeholder500x500 +
+
+ +
+ + + +
+ + + + +
+ + + + + + + diff --git a/docs/5.3/examples/cheatsheet-rtl/index.html b/docs/5.3/examples/cheatsheet-rtl/index.html new file mode 100644 index 0000000000..aa614accc8 --- /dev/null +++ b/docs/5.3/examples/cheatsheet-rtl/index.html @@ -0,0 +1,1873 @@ + + + + + + + + + ورقة الغش · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+

+ Bootstrap + ورقة الغش +

+ جدول بيانات LTR +
+
+ +
+
+

المحتوى

+ +
+
+

النصوص

+ دليل الإستخدام +
+ +
+
+

العرض 1

+

العرض 2

+

العرض 3

+

العرض 4

+

العرض 5

+

العرض 6

+
+ + +
+

عنوان 1

+

عنوان 2

+

عنوان 3

+

عنوان 4

+

عنوان 5

+

عنوان 6

+
+ + +
+

+ هذه قطعة إملائية متميزة، فهي مصممة لتكون بارزة من بين القطع الإملائية الأخرى. +

+
+ + +
+

يمكنك استخدام تصنيف mark لتحديد نص.

+

من المفترض أن يتم التعامل مع هذا السطر كنص محذوف.

+

من المفترض أن يتم التعامل مع هذا السطر على أنه لم يعد دقيقًا.

+

من المفترض أن يتم التعامل مع هذا السطر كإضافة إلى المستند.

+

سيتم عرض النص في هذا السطر كما وتحته خط.

+

من المفترض أن يتم التعامل مع هذا السطر على أنه يحوي تفاصيل صغيرة.

+

هذا السطر يحوي نص عريض.

+

هذا السطر يحوي نص مائل.

+
+ + +
+
+
+ + +
+
+

إقتباس مبهر، موضوع في عنصر blockquote

+
شخص مشهور في عنوان المصدر
+
+
+ + +
+
    +
  • هذه قائمة عناصر.
    • +
  • بالرغم من أنها مصممة كي لا تظهر كذلك.
    • +
  • إلا أنها مجهزة كـ قائمة خلف الكواليس
    • +
  • هذا التصميم ينطبق فقد على القائمة الرئيسية
    • +
  • القوائم الفرعية +
      +
    • لا تتأثر بهذا التصميم
      • +
    • فهي تظهر عليها علامات الترقيم
      • +
    • وتحتوي على مساحة فارغة بجوارها
      • +
    +
    • +
  • قد يكون هذا التصميم مفيدًا في بعض الأحيان.
    • +
+
+ + +
+
    +
  • هذا عنصر في قائمة.
    • +
  • وهذا أيضًا.
    • +
  • لكنهم يظهرون متجاورين.
    • +
+
+ +
+
+
+
+

الصور

+ دليل الإستخدام +
+ +
+
+ Placeholderصورة مستجيبة +
+ + +
+ صورة عنصر نائب مربع عام مع حدود بيضاء حولها ، مما يجعلها تشبه صورة تم التقاطها بكاميرا فورية قديمة200x200 +
+ +
+
+
+
+

الجداول

+ دليل الإستخدام +
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#الاسم الاولالكنيةالاسم المستعار
1MarkOtto@mdo
2JacobThornton@fat
3Larry the Bird@twitter
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#الاسم الاولالكنيةالاسم المستعار
1MarkOtto@mdo
2JacobThornton@fat
3Larry the Bird@twitter
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Classعنوانعنوان
Defaultخليةخلية
Primaryخليةخلية
Secondaryخليةخلية
Successخليةخلية
Dangerخليةخلية
Warningخليةخلية
Infoخليةخلية
Lightخليةخلية
Darkخليةخلية
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#الاسم الاولالكنيةالاسم المستعار
1MarkOtto@mdo
2JacobThornton@fat
3Larry the Bird@twitter
+
+ +
+
+ +
+ +
+

النماذج

+ +
+
+

نظرة عامة

+ دليل الإستخدام +
+ +
+
+
+
+ + +
لن نقوم بمشاركة بريدك الإلكتروني مع أي شخص آخر.
+
+
+ + +
+
+ + +
+
+ + +
+
+ أزرار الاختيار الأحادي +
+ + +
+
+ + +
+
+
+ + +
+
+ + +
+
+ + +
+ +
+
+ +
+
+
+
+

الحقول المعطلة

+ دليل الإستخدام +
+ +
+
+
+
+
+ + +
+
+ + +
+
+
+ + +
+
+
+ أزرار اختيار أحادي معطلين +
+ + +
+
+ + +
+
+
+ + +
+
+ + +
+
+ + +
+ +
+
+
+ +
+
+
+
+

الأحجام

+ دليل الإستخدام +
+ +
+
+
+ +
+
+ +
+
+ +
+
+ + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
+
+

مجموعة الإدخال

+ دليل الإستخدام +
+ +
+
+
+ أنا اسمي + +
+
+ + وغيرها +
+ +
+ + https://example.com/users/ +
+
+ .00 + + $ +
+
+ مع textarea + +
+
+ +
+
+
+
+

الحقول ذوي العناوين العائمة

+ دليل الإستخدام +
+ +
+
+
+
+ + +
+
+ + +
+
+
+ +
+
+
+
+

التحقق

+ دليل الإستخدام +
+ +
+
+
+
+ + +
+ يبدو صحيحًا! +
+
+
+ + +
+ يبدو صحيحًا! +
+
+
+ +
+ + @ +
+ يرجى اختيار اسم مستخدم. +
+
+
+
+ + +
+ يرجى إدخال مدينة صحيحة. +
+
+
+ + +
+ يرجى اختيار ولاية صحيحة. +
+
+
+ + +
+ يرجى إدخال رمز بريدي صحيح. +
+
+
+
+ + +
+ تجب الموافقة قبل إرسال النموذج. +
+
+
+
+ +
+
+
+ +
+
+
+ +
+

العناصر

+ +
+
+

المطوية

+ دليل الإستخدام +
+ +
+
+
+
+

+ +

+
+
+ هذا هو محتوى عنصر المطوية الأول. سيكون المحتوى مخفيًا بشكل إفتراضي حتى يقوم Bootstrap بإضافة الكلاسات اللازمة لكل عنصر في المطوية. هذه الكلاسات تتحكم بالمظهر العام ووتتحكم أيضا بإظهار وإخفاء أقسام المطوية عبر حركات CSS الإنتقالية. يمكنك تعديل أي من هذه عبر كلاسات CSS خاصة بك، او عبر تغيير القيم الإفتراضية المقدمة من Bootstrap. من الجدير بالذكر أنه يمكن وضع أي كود HTML هنا، ولكن الحركة الإنتقالية قد تحد من الoverflow. +
+
+
+
+

+ +

+
+
+ هذا هو محتوى عنصر المطوية الثاني. سيكون المحتوى مخفيًا بشكل إفتراضي حتى يقوم Bootstrap بإضافة الكلاسات اللازمة لكل عنصر في المطوية. هذه الكلاسات تتحكم بالمظهر العام ووتتحكم أيضا بإظهار وإخفاء أقسام المطوية عبر حركات CSS الإنتقالية. يمكنك تعديل أي من هذه عبر كلاسات CSS خاصة بك، او عبر تغيير القيم الإفتراضية المقدمة من Bootstrap. من الجدير بالذكر أنه يمكن وضع أي كود HTML هنا، ولكن الحركة الإنتقالية قد تحد من الoverflow. +
+
+
+
+

+ +

+
+
+ هذا هو محتوى عنصر المطوية الثالث. سيكون المحتوى مخفيًا بشكل إفتراضي حتى يقوم Bootstrap بإضافة الكلاسات اللازمة لكل عنصر في المطوية. هذه الكلاسات تتحكم بالمظهر العام ووتتحكم أيضا بإظهار وإخفاء أقسام المطوية عبر حركات CSS الإنتقالية. يمكنك تعديل أي من هذه عبر كلاسات CSS خاصة بك، او عبر تغيير القيم الإفتراضية المقدمة من Bootstrap. من الجدير بالذكر أنه يمكن وضع أي كود HTML هنا، ولكن الحركة الإنتقالية قد تحد من الoverflow. +
+
+
+
+
+ +
+
+
+
+

الإنذارات

+ دليل الإستخدام +
+ +
+
+ + + + + + + + + +
+ + +
+ +
+ +
+
+
+
+

الشارة

+ دليل الإستخدام +
+ +
+
+

مثال على عنوان جديد

+

مثال على عنوان جديد

+

مثال على عنوان جديد

+

مثال على عنوان جديد

+

مثال على عنوان جديد

+

مثال على عنوان جديد

+

مثال على عنوان جديد

+

مثال على عنوان جديد

+
+ + +
+ + Primary + Secondary + Success + Danger + Warning + Info + Light + Dark +
+ +
+
+ +
+
+

الأزرار

+ دليل الإستخدام +
+ +
+
+ + + + + + + + + + + +
+ + +
+ + + + + + + + + +
+ + +
+ + + +
+ +
+
+ +
+
+

البطاقة

+ دليل الإستخدام +
+ +
+
+
+
+
+ Placeholderغطاء الصورة +
+
عنوان البطاقة
+

بعض الأمثلة السريعة للنصوص للبناء على عنوان البطاقة وتشكيل الجزء الأكبر من محتوى البطاقة.

+ اذهب لمكان ما +
+
+
+
+
+
+ متميز +
+
+
عنوان البطاقة
+

بعض الأمثلة السريعة للنصوص للبناء على عنوان البطاقة وتشكيل الجزء الأكبر من محتوى البطاقة.

+ اذهب لمكان ما +
+
+ منذ يومان +
+
+
+
+
+
+
عنوان البطاقة
+

بعض الأمثلة السريعة للنصوص للبناء على عنوان البطاقة وتشكيل الجزء الأكبر من محتوى البطاقة.

+
+
    +
  • عنصر
    • +
  • عنصر آخر
    • +
  • عنصر ثالث
    • +
+
+ رابط البطاقة + رابط آخر +
+
+
+
+
+
+
+ Placeholderصورة +
+
+
+
عنوان البطاقة
+

هذه بطاقة أعرض مع نص داعم تحتها كمقدمة طبيعية لمحتوى إضافي. هذا المحتوى أطول قليلاً.

+

آخر تحديث منذ 3 دقائق

+
+
+
+
+
+
+
+ +
+
+ + +
+
+

مجموعة العناصر

+ دليل الإستخدام +
+ +
+
+
    +
  • عنصر معطل
    • +
  • عنصر ثاني
    • +
  • عنصر ثالث
    • +
  • عنصر رابع
    • +
  • وعنصر خامس أيضًا
    • +
+
+ + +
+
    +
  • عنصر
    • +
  • عنصر ثاني
    • +
  • عنصر ثالث
    • +
  • عنصر رابع
    • +
  • وعنصر خامس أيضًا
    • +
+
+ + +
+
+ عنصر مجموعة قائمة default بسيط + + عنصر مجموعة قائمة primary بسيط + عنصر مجموعة قائمة secondary بسيط + عنصر مجموعة قائمة success بسيط + عنصر مجموعة قائمة danger بسيط + عنصر مجموعة قائمة warning بسيط + عنصر مجموعة قائمة info بسيط + عنصر مجموعة قائمة light بسيط + عنصر مجموعة قائمة dark بسيط +
+
+ +
+
+ + + + +
+
+

الصناديق المنبثقة

+ دليل الإستخدام +
+ +
+
+ +
+ + +
+ + + + +
+ +
+
+ +
+
+

المخطوطة

+ دليل الإستخدام +
+ +
+
+ +
+

@fat

+

محتوى لتوضيح كيف تعمل المخطوطة. ببساطة، المخطوطة عبارة عن منشور طويل يحتوي على عدة أقسام، ولديه شريط تنقل يسهل الوصول إلى هذه الأقسام الفرعية.

+

@mdo

+

بصرف النظر عن تحسيننا جدوى المكيّفات أو عدم تحسينها، فإن الطلب على الطاقة سيزداد. وطبقاً لما جاء في مقالة معهد ماساشوستس للتكنولوجيا، السالف ذكره، ثمَّة أمر يجب عدم إغفاله، وهو كيف أن هذا الطلب سيضغط على نظم توفير الطاقة الحالية. إذ لا بد من إعادة تأهيل كل شبكات الكهرباء، وتوسيعها لتلبية طلب الطاقة في زمن الذروة، خلال موجات الحرارة المتزايدة. فحين يكون الحر شديداً يجنح الناس إلى البقاء في الداخل، وإلى زيادة تشغيل المكيّفات، سعياً إلى جو لطيف وهم يستخدمون أدوات وأجهزة مختلفة أخرى.

+

واحد

+

وكل هذه الأمور المتزامنة من تشغيل الأجهزة، يزيد الضغط على شبكات الطاقة، كما أسلفنا. لكن مجرد زيادة سعة الشبكة ليس كافياً. إذ لا بد من تطوير الشبكات الذكية التي تستخدم الجسّاسات، ونظم المراقبة، والبرامج الإلكترونية، لتحديد متى يكون الشاغلون في المبنى، ومتى يكون ثمَّة حاجة إلى الطاقة، ومتى تكون الحرارة منخفضة، وبذلك يخرج الناس، فلا يستخدمون كثيراً من الكهرباء.

+

اثنان

+

مع الأسف، كل هذه الحلول المبتكرة مكلِّفة، وهذا ما يجعلها عديمة الجدوى في نظر بعض الشركات الخاصة والمواطن المتقشّف. إن بعض الأفراد الواعين بيئياً يبذلون قصارى جهدهم في تقليص استهلاكهم من الطاقة، ويعون جيداً أهمية أجهزة التكييف المجدية والأرفق بالبيئة. ولكن جهات كثيرة لن تتحرّك لمجرد حافز سلامة المناخ ووقف هدر الطاقة، ما دامت لا تحركها حوافز قانونية. وعلى الحكومات أن تُقدِم عند الاهتمام بالتغيّر المناخي، على وضع التشريعات المناسبة. فبالنظم والحوافز والدعم، يمكن دفع الشركات إلى اعتماد الحلول الأجدى في مكاتبها.

+

ثلاثة

+

وكما يتبيّن لنا، من عدد الحلول الملطِّفة للمشكلة، ومن تنوّعها، وهي الحلول التي أسلفنا الحديث عنها، فإن التكنولوجيا التي نحتاج إليها من أجل معالجة هذه التحديات، هي في مدى قدرتنا، لكنها ربما تتطلّب بعض التحسين، ودعماً استثمارياً أكبر!

+

ولا مانع من إضافة محتوى آخر ليس تحت أي قسم معين.

+
+
+
+
+
+
+

الدوائر المتحركة

+ دليل الإستخدام +
+ +
+
+ + + + + + + + + +
+ + +
+ + + + + + + + + +
+ +
+
+
+
+

الإشعارات

+ دليل الإستخدام +
+ +
+
+ +
+ +
+
+
+
+

التلميحات

+ دليل الإستخدام +
+ +
+
+ + + + + +
+ +
+
+
+
+ + + + + + + + + + + + diff --git a/docs/5.3/examples/cheatsheet/cheatsheet.css b/docs/5.3/examples/cheatsheet/cheatsheet.css new file mode 100644 index 0000000000..e2f99b8592 --- /dev/null +++ b/docs/5.3/examples/cheatsheet/cheatsheet.css @@ -0,0 +1,164 @@ +body { + scroll-behavior: smooth; +} + +/** + * Bootstrap "Journal code" icon + * @link https://icons.getbootstrap.com/icons/journal-code/ + */ +.bd-heading a::before { + display: inline-block; + width: 1em; + height: 1em; + margin-right: .25rem; + content: ""; + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='%25230d6efd' viewBox='0 0 16 16'%3E%3Cpath d='M4 1h8a2 2 0 0 1 2 2v10a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2h1a1 1 0 0 0 1 1h8a1 1 0 0 0 1-1V3a1 1 0 0 0-1-1H4a1 1 0 0 0-1 1H2a2 2 0 0 1 2-2z'/%3E%3Cpath d='M2 5v-.5a.5.5 0 0 1 1 0V5h.5a.5.5 0 0 1 0 1h-2a.5.5 0 0 1 0-1H2zm0 3v-.5a.5.5 0 0 1 1 0V8h.5a.5.5 0 0 1 0 1h-2a.5.5 0 0 1 0-1H2zm0 3v-.5a.5.5 0 0 1 1 0v.5h.5a.5.5 0 0 1 0 1h-2a.5.5 0 0 1 0-1H2z'/%3E%3Cpath fill-rule='evenodd' d='M8.646 5.646a.5.5 0 0 1 .708 0l2 2a.5.5 0 0 1 0 .708l-2 2a.5.5 0 0 1-.708-.708L10.293 8 8.646 6.354a.5.5 0 0 1 0-.708zm-1.292 0a.5.5 0 0 0-.708 0l-2 2a.5.5 0 0 0 0 .708l2 2a.5.5 0 0 0 .708-.708L5.707 8l1.647-1.646a.5.5 0 0 0 0-.708z'/%3E%3C/svg%3E"); + background-size: 1em; +} + +/* stylelint-disable-next-line selector-max-universal */ +.bd-heading + div > * + * { + margin-top: 3rem; +} + +/* Table of contents */ +.bd-aside a { + padding: .1875rem .5rem; + margin-top: .125rem; + margin-left: .3125rem; + color: rgba(0, 0, 0, .65); +} + +.bd-aside a:hover, +.bd-aside a:focus { + color: rgba(0, 0, 0, .85); + background-color: rgba(121, 82, 179, .1); +} + +.bd-aside .active { + font-weight: 600; + color: rgba(0, 0, 0, .85); +} + +.bd-aside .btn { + padding: .25rem .5rem; + font-weight: 600; + color: rgba(0, 0, 0, .65); +} + +.bd-aside .btn:hover, +.bd-aside .btn:focus { + color: rgba(0, 0, 0, .85); + background-color: rgba(121, 82, 179, .1); +} + +.bd-aside .btn:focus { + box-shadow: 0 0 0 1px rgba(121, 82, 179, .7); +} + +.bd-aside .btn::before { + width: 1.25em; + line-height: 0; + content: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' viewBox='0 0 16 16'%3e%3cpath fill='none' stroke='rgba%280,0,0,.5%29' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M5 14l6-6-6-6'/%3e%3c/svg%3e"); + transition: transform .35s ease; + + /* rtl:raw: + transform: rotate(180deg) translateX(-2px); + */ + transform-origin: .5em 50%; +} + +.bd-aside .btn[aria-expanded="true"]::before { + transform: rotate(90deg)/* rtl:ignore */; +} + + +/* Examples */ +.scrollspy-example { + height: 200px; +} + +[id="modal"] .bd-example .btn, +[id="buttons"] .bd-example .btn, +[id="tooltips"] .bd-example .btn, +[id="popovers"] .bd-example .btn, +[id="dropdowns"] .bd-example .btn-group, +[id="dropdowns"] .bd-example .dropdown, +[id="dropdowns"] .bd-example .dropup, +[id="dropdowns"] .bd-example .dropend, +[id="dropdowns"] .bd-example .dropstart { + margin: 0 1rem 1rem 0; +} + +/* Layout */ +@media (min-width: 1200px) { + body { + display: grid; + grid-template-rows: auto; + grid-template-columns: 1fr 4fr 1fr; + gap: 1rem; + } + + .bd-header { + position: fixed; + top: 0; + /* rtl:begin:ignore */ + right: 0; + left: 0; + /* rtl:end:ignore */ + z-index: 1030; + grid-column: 1 / span 3; + } + + .bd-aside, + .bd-cheatsheet { + padding-top: 4rem; + } + + /** + * 1. Too bad only Firefox supports subgrids ATM + */ + .bd-cheatsheet, + .bd-cheatsheet section, + .bd-cheatsheet article { + display: inherit; /* 1 */ + grid-template-rows: auto; + grid-template-columns: 1fr 4fr; + grid-column: 1 / span 2; + gap: inherit; /* 1 */ + } + + .bd-aside { + grid-area: 1 / 3; + scroll-margin-top: 4rem; + } + + .bd-cheatsheet section, + .bd-cheatsheet section > h2 { + top: 2rem; + scroll-margin-top: 2rem; + } + + .bd-cheatsheet section > h2::before { + position: absolute; + /* rtl:begin:ignore */ + top: 0; + right: 0; + bottom: -2rem; + left: 0; + /* rtl:end:ignore */ + z-index: -1; + content: ""; + background-image: linear-gradient(to bottom, rgba(255, 255, 255, 1) calc(100% - 3rem), rgba(255, 255, 255, .01)); + } + + .bd-cheatsheet article, + .bd-cheatsheet .bd-heading { + top: 8rem; + scroll-margin-top: 8rem; + } + + .bd-cheatsheet .bd-heading { + z-index: 1; + } +} diff --git a/docs/5.3/examples/cheatsheet/cheatsheet.js b/docs/5.3/examples/cheatsheet/cheatsheet.js new file mode 100644 index 0000000000..e25a89e75d --- /dev/null +++ b/docs/5.3/examples/cheatsheet/cheatsheet.js @@ -0,0 +1,73 @@ +/* global bootstrap: false */ + +(() => { + 'use strict' + + // Tooltip and popover demos + document.querySelectorAll('.tooltip-demo') + .forEach(tooltip => { + new bootstrap.Tooltip(tooltip, { + selector: '[data-bs-toggle="tooltip"]' + }) + }) + + document.querySelectorAll('[data-bs-toggle="popover"]') + .forEach(popover => { + new bootstrap.Popover(popover) + }) + + document.querySelectorAll('.toast') + .forEach(toastNode => { + const toast = new bootstrap.Toast(toastNode, { + autohide: false + }) + + toast.show() + }) + + // Disable empty links and submit buttons + document.querySelectorAll('[href="#"], [type="submit"]') + .forEach(link => { + link.addEventListener('click', event => { + event.preventDefault() + }) + }) + + function setActiveItem() { + const { hash } = window.location + + if (hash === '') { + return + } + + const link = document.querySelector(`.bd-aside a[href="${hash}"]`) + + if (!link) { + return + } + + const active = document.querySelector('.bd-aside .active') + const parent = link.parentNode.parentNode.previousElementSibling + + link.classList.add('active') + + if (parent.classList.contains('collapsed')) { + parent.click() + } + + if (!active) { + return + } + + const expanded = active.parentNode.parentNode.previousElementSibling + + active.classList.remove('active') + + if (expanded && parent !== expanded) { + expanded.click() + } + } + + setActiveItem() + window.addEventListener('hashchange', setActiveItem) +})() diff --git a/docs/5.3/examples/cheatsheet/cheatsheet.rtl.css b/docs/5.3/examples/cheatsheet/cheatsheet.rtl.css new file mode 100644 index 0000000000..e04d848717 --- /dev/null +++ b/docs/5.3/examples/cheatsheet/cheatsheet.rtl.css @@ -0,0 +1,157 @@ +body { + scroll-behavior: smooth; +} + +/** + * Bootstrap "Journal code" icon + * @link https://icons.getbootstrap.com/icons/journal-code/ + */ +.bd-heading a::before { + display: inline-block; + width: 1em; + height: 1em; + margin-left: .25rem; + content: ""; + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='%25230d6efd' viewBox='0 0 16 16'%3E%3Cpath d='M4 1h8a2 2 0 0 1 2 2v10a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2h1a1 1 0 0 0 1 1h8a1 1 0 0 0 1-1V3a1 1 0 0 0-1-1H4a1 1 0 0 0-1 1H2a2 2 0 0 1 2-2z'/%3E%3Cpath d='M2 5v-.5a.5.5 0 0 1 1 0V5h.5a.5.5 0 0 1 0 1h-2a.5.5 0 0 1 0-1H2zm0 3v-.5a.5.5 0 0 1 1 0V8h.5a.5.5 0 0 1 0 1h-2a.5.5 0 0 1 0-1H2zm0 3v-.5a.5.5 0 0 1 1 0v.5h.5a.5.5 0 0 1 0 1h-2a.5.5 0 0 1 0-1H2z'/%3E%3Cpath fill-rule='evenodd' d='M8.646 5.646a.5.5 0 0 1 .708 0l2 2a.5.5 0 0 1 0 .708l-2 2a.5.5 0 0 1-.708-.708L10.293 8 8.646 6.354a.5.5 0 0 1 0-.708zm-1.292 0a.5.5 0 0 0-.708 0l-2 2a.5.5 0 0 0 0 .708l2 2a.5.5 0 0 0 .708-.708L5.707 8l1.647-1.646a.5.5 0 0 0 0-.708z'/%3E%3C/svg%3E"); + background-size: 1em; +} + +/* stylelint-disable-next-line selector-max-universal */ +.bd-heading + div > * + * { + margin-top: 3rem; +} + +/* Table of contents */ +.bd-aside a { + padding: .1875rem .5rem; + margin-top: .125rem; + margin-right: .3125rem; + color: rgba(0, 0, 0, .65); +} + +.bd-aside a:hover, +.bd-aside a:focus { + color: rgba(0, 0, 0, .85); + background-color: rgba(121, 82, 179, .1); +} + +.bd-aside .active { + font-weight: 600; + color: rgba(0, 0, 0, .85); +} + +.bd-aside .btn { + padding: .25rem .5rem; + font-weight: 600; + color: rgba(0, 0, 0, .65); +} + +.bd-aside .btn:hover, +.bd-aside .btn:focus { + color: rgba(0, 0, 0, .85); + background-color: rgba(121, 82, 179, .1); +} + +.bd-aside .btn:focus { + box-shadow: 0 0 0 1px rgba(121, 82, 179, .7); +} + +.bd-aside .btn::before { + width: 1.25em; + line-height: 0; + content: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' viewBox='0 0 16 16'%3e%3cpath fill='none' stroke='rgba%280,0,0,.5%29' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M5 14l6-6-6-6'/%3e%3c/svg%3e"); + transition: transform .35s ease; + transform: rotate(180deg) translateX(-2px); + transform-origin: .5em 50%; +} + +.bd-aside .btn[aria-expanded="true"]::before { + transform: rotate(90deg); +} + + +/* Examples */ +.scrollspy-example { + height: 200px; +} + +[id="modal"] .bd-example .btn, +[id="buttons"] .bd-example .btn, +[id="tooltips"] .bd-example .btn, +[id="popovers"] .bd-example .btn, +[id="dropdowns"] .bd-example .btn-group, +[id="dropdowns"] .bd-example .dropdown, +[id="dropdowns"] .bd-example .dropup, +[id="dropdowns"] .bd-example .dropend, +[id="dropdowns"] .bd-example .dropstart { + margin: 0 0 1rem 1rem; +} + +/* Layout */ +@media (min-width: 1200px) { + body { + display: grid; + grid-template-rows: auto; + grid-template-columns: 1fr 4fr 1fr; + gap: 1rem; + } + + .bd-header { + position: fixed; + top: 0; + right: 0; + left: 0; + z-index: 1030; + grid-column: 1 / span 3; + } + + .bd-aside, + .bd-cheatsheet { + padding-top: 4rem; + } + + /** + * 1. Too bad only Firefox supports subgrids ATM + */ + .bd-cheatsheet, + .bd-cheatsheet section, + .bd-cheatsheet article { + display: inherit; /* 1 */ + grid-template-rows: auto; + grid-template-columns: 1fr 4fr; + grid-column: 1 / span 2; + gap: inherit; /* 1 */ + } + + .bd-aside { + grid-area: 1 / 3; + scroll-margin-top: 4rem; + } + + .bd-cheatsheet section, + .bd-cheatsheet section > h2 { + top: 2rem; + scroll-margin-top: 2rem; + } + + .bd-cheatsheet section > h2::before { + position: absolute; + top: 0; + right: 0; + bottom: -2rem; + left: 0; + z-index: -1; + content: ""; + background-image: linear-gradient(to bottom, rgba(255, 255, 255, 1) calc(100% - 3rem), rgba(255, 255, 255, .01)); + } + + .bd-cheatsheet article, + .bd-cheatsheet .bd-heading { + top: 8rem; + scroll-margin-top: 8rem; + } + + .bd-cheatsheet .bd-heading { + z-index: 1; + } +} diff --git a/docs/5.3/examples/cheatsheet/index.html b/docs/5.3/examples/cheatsheet/index.html new file mode 100644 index 0000000000..47f6199bb6 --- /dev/null +++ b/docs/5.3/examples/cheatsheet/index.html @@ -0,0 +1,1858 @@ + + + + + + + + + Cheatsheet · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+

+ Bootstrap + Cheatsheet +

+ RTL cheatsheet +
+
+ +
+
+

Contents

+ +
+
+

Typography

+ Documentation +
+ +
+
+

Display 1

+

Display 2

+

Display 3

+

Display 4

+

Display 5

+

Display 6

+
+ + +
+

Heading 1

+

Heading 2

+

Heading 3

+

Heading 4

+

Heading 5

+

Heading 6

+
+ + +
+

+ This is a lead paragraph. It stands out from regular paragraphs. +

+
+ + +
+

You can use the mark tag to highlight text.

+

This line of text is meant to be treated as deleted text.

+

This line of text is meant to be treated as no longer accurate.

+

This line of text is meant to be treated as an addition to the document.

+

This line of text will render as underlined.

+

This line of text is meant to be treated as fine print.

+

This line rendered as bold text.

+

This line rendered as italicized text.

+
+ + +
+
+
+ + +
+
+

A well-known quote, contained in a blockquote element.

+
Someone famous in Source Title
+
+
+ + +
+
    +
  • This is a list.
    • +
  • It appears completely unstyled.
    • +
  • Structurally, it's still a list.
    • +
  • However, this style only applies to immediate child elements.
    • +
  • Nested lists: +
      +
    • are unaffected by this style
      • +
    • will still show a bullet
      • +
    • and have appropriate left margin
      • +
    +
    • +
  • This may still come in handy in some situations.
    • +
+
+ + +
+
    +
  • This is a list item.
    • +
  • And another one.
    • +
  • But they're displayed inline.
    • +
+
+ +
+
+
+
+

Images

+ Documentation +
+ +
+
+ PlaceholderResponsive image +
+ + +
+ A generic square placeholder image with a white border around it, making it resemble a photograph taken with an old instant camera200x200 +
+ +
+
+
+
+

Tables

+ Documentation +
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#FirstLastHandle
1MarkOtto@mdo
2JacobThornton@fat
3Larry the Bird@twitter
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#FirstLastHandle
1MarkOtto@mdo
2JacobThornton@fat
3Larry the Bird@twitter
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ClassHeadingHeading
DefaultCellCell
PrimaryCellCell
SecondaryCellCell
SuccessCellCell
DangerCellCell
WarningCellCell
InfoCellCell
LightCellCell
DarkCellCell
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#FirstLastHandle
1MarkOtto@mdo
2JacobThornton@fat
3Larry the Bird@twitter
+
+ +
+
+
+
+

Figures

+ Documentation +
+ +
+
+
+ Placeholder400x300 +
A caption for the above image.
+
+
+ +
+
+
+ +
+

Forms

+ +
+
+

Overview

+ Documentation +
+ +
+
+
+
+ + +
We'll never share your email with anyone else.
+
+
+ + +
+
+ + +
+
+ + +
+
+ Radios buttons +
+ + +
+
+ + +
+
+
+ + +
+
+ + +
+
+ + +
+ +
+
+ +
+
+
+
+

Disabled forms

+ Documentation +
+ +
+
+
+
+
+ + +
+
+ + +
+
+
+ + +
+
+
+ Disabled radios buttons +
+ + +
+
+ + +
+
+
+ + +
+
+ + +
+
+ + +
+ +
+
+
+ +
+
+
+
+

Sizing

+ Documentation +
+ +
+
+
+ +
+
+ +
+
+ +
+
+ + +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
+
+

Input group

+ Documentation +
+ +
+
+
+ @ + +
+
+ + @example.com +
+ +
+ https://example.com/users/ + +
+
+ $ + + .00 +
+
+ With textarea + +
+
+ +
+
+
+
+

Floating labels

+ Documentation +
+ +
+
+
+
+ + +
+
+ + +
+
+
+ +
+
+
+
+

Validation

+ Documentation +
+ +
+
+
+
+ + +
+ Looks good! +
+
+
+ + +
+ Looks good! +
+
+
+ +
+ @ + +
+ Please choose a username. +
+
+
+
+ + +
+ Please provide a valid city. +
+
+
+ + +
+ Please select a valid state. +
+
+
+ + +
+ Please provide a valid zip. +
+
+
+
+ + +
+ You must agree before submitting. +
+
+
+
+ +
+
+
+ +
+
+
+ +
+

Components

+ +
+
+

Accordion

+ Documentation +
+ +
+
+
+
+

+ +

+
+
+ This is the first item's accordion body. It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the .accordion-body, though the transition does limit overflow. +
+
+
+
+

+ +

+
+
+ This is the second item's accordion body. It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the .accordion-body, though the transition does limit overflow. +
+
+
+
+

+ +

+
+
+ This is the third item's accordion body. It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the .accordion-body, though the transition does limit overflow. +
+
+
+
+
+ +
+
+
+
+

Alerts

+ Documentation +
+ +
+
+ + + + + + + + + +
+ + +
+ +
+ +
+
+
+
+

Badge

+ Documentation +
+ +
+
+

Example heading New

+

Example heading New

+

Example heading New

+

Example heading New

+

Example heading New

+

Example heading New

+

Example heading New

+

Example heading New

+
+ + +
+ + Primary + Secondary + Success + Danger + Warning + Info + Light + Dark +
+ +
+
+ +
+
+

Buttons

+ Documentation +
+ +
+
+ + + + + + + + + + + +
+ + +
+ + + + + + + + + +
+ + +
+ + + +
+ +
+
+
+
+

Button group

+ Documentation +
+ +
+
+ +
+ +
+
+
+
+

Card

+ Documentation +
+ +
+
+
+
+
+ PlaceholderImage cap +
+
Card title
+

Some quick example text to build on the card title and make up the bulk of the card's content.

+ Go somewhere +
+
+
+
+
+
+ Featured +
+
+
Card title
+

Some quick example text to build on the card title and make up the bulk of the card's content.

+ Go somewhere +
+
+ 2 days ago +
+
+
+
+
+
+
Card title
+

Some quick example text to build on the card title and make up the bulk of the card's content.

+
+
    +
  • An item
    • +
  • A second item
    • +
  • A third item
    • +
+
+ Card link + Another link +
+
+
+
+
+
+
+ PlaceholderImage +
+
+
+
Card title
+

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

+

Last updated 3 mins ago

+
+
+
+
+
+
+
+ +
+
+ + +
+
+

List group

+ Documentation +
+ +
+
+
    +
  • A disabled item
    • +
  • A second item
    • +
  • A third item
    • +
  • A fourth item
    • +
  • And a fifth one
    • +
+
+ + +
+
    +
  • An item
    • +
  • A second item
    • +
  • A third item
    • +
  • A fourth item
    • +
  • And a fifth one
    • +
+
+ + +
+
+ A simple default list group item + + A simple primary list group item + A simple secondary list group item + A simple success list group item + A simple danger list group item + A simple warning list group item + A simple info list group item + A simple light list group item + A simple dark list group item +
+
+ +
+
+ + + + +
+
+

Popovers

+ Documentation +
+ +
+
+ +
+ + +
+ + + + +
+ +
+
+
+
+

Progress

+ Documentation +
+ +
+
+
+
0%
+
+
+
25%
+
+
+
50%
+
+
+
75%
+
+
+
100%
+
+
+ + +
+
+
+
+
+
+
+
+
+
+ +
+
+
+
+

Scrollspy

+ Documentation +
+ +
+
+ +
+

First heading

+

This is some placeholder content for the scrollspy page. Note that as you scroll down the page, the appropriate navigation link is highlighted. It's repeated throughout the component example. We keep adding some more example copy here to emphasize the scrolling and highlighting.

+

Second heading

+

This is some placeholder content for the scrollspy page. Note that as you scroll down the page, the appropriate navigation link is highlighted. It's repeated throughout the component example. We keep adding some more example copy here to emphasize the scrolling and highlighting.

+

Third heading

+

This is some placeholder content for the scrollspy page. Note that as you scroll down the page, the appropriate navigation link is highlighted. It's repeated throughout the component example. We keep adding some more example copy here to emphasize the scrolling and highlighting.

+

Fourth heading

+

This is some placeholder content for the scrollspy page. Note that as you scroll down the page, the appropriate navigation link is highlighted. It's repeated throughout the component example. We keep adding some more example copy here to emphasize the scrolling and highlighting.

+

Fifth heading

+

This is some placeholder content for the scrollspy page. Note that as you scroll down the page, the appropriate navigation link is highlighted. It's repeated throughout the component example. We keep adding some more example copy here to emphasize the scrolling and highlighting.

+
+
+
+
+
+
+

Spinners

+ Documentation +
+ +
+
+ + + + + + + + + +
+ + +
+ + + + + + + + + +
+ +
+
+
+
+

Toasts

+ Documentation +
+ +
+
+ +
+ +
+
+
+
+

Tooltips

+ Documentation +
+ +
+
+ + + + + +
+ +
+
+
+
+ + + + + + + + + + + + diff --git a/docs/5.3/examples/checkout-rtl/index.html b/docs/5.3/examples/checkout-rtl/index.html new file mode 100644 index 0000000000..a631e9f775 --- /dev/null +++ b/docs/5.3/examples/checkout-rtl/index.html @@ -0,0 +1,315 @@ + + + + + + + + + مثال إتمام الشراء · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ +

نموذج إتمام الشراء

+

فيما يلي مثال على نموذج تم إنشاؤه بالكامل باستخدام عناصر تحكم النموذج في Bootstrap. لكل مجموعة نماذج مطلوبة حالة تحقق يمكن تشغيلها بمحاولة إرسال النموذج دون استكماله.

+
+ +
+
+

+ عربة التسوق + 3 +

+
    +
  • +
    +
    اسم المنتج
    + وصف مختصر +
    + $12 +
    • +
  • +
    +
    المنتج الثاني
    + وصف مختصر +
    + $8 +
    • +
  • +
    +
    البند الثالث
    + وصف مختصر +
    + $5 +
    • +
  • +
    +
    رمز ترويجي
    + EXAMPLECODE +
    + -$5 +
    • +
  • + مجموع (USD) + $20 +
    • +
+ +
+
+ + +
+
+
+
+

عنوان الفوترة

+
+
+
+ + +
+ يرجى إدخال اسم أول صحيح. +
+
+ +
+ + +
+ يرجى إدخال اسم عائلة صحيح. +
+
+ +
+ +
+ @ + +
+ اسم المستخدم الخاص بك مطلوب. +
+
+
+ +
+ + +
+ يرجى إدخال عنوان بريد إلكتروني صحيح لتصلكم تحديثات الشحن. +
+
+ +
+ + +
+ يرجى إدخال عنوان الشحن الخاص بك. +
+
+ +
+ + +
+ +
+ + +
+ يرجى اختيار بلد صحيح. +
+
+ +
+ + +
+ يرجى اختيار اسم منطقة صحيح. +
+
+ +
+ + +
+ الرمز البريدي مطلوب. +
+
+
+ +
+ +
+ + +
+ +
+ + +
+ +
+ +

طريقة الدفع

+ +
+
+ + +
+
+ + +
+
+ + +
+
+ +
+
+ + + الاسم الكامل كما هو معروض على البطاقة +
+ الاسم على البطاقة مطلوب +
+
+ +
+ + +
+ رقم بطاقة الائتمان مطلوب +
+
+ +
+ + +
+ تاريخ انتهاء الصلاحية مطلوب +
+
+ +
+ + +
+ رمز الحماية مطلوب +
+
+
+ +
+ + +
+
+
+
+ +
+ + + + + + + diff --git a/docs/5.3/examples/checkout/checkout.css b/docs/5.3/examples/checkout/checkout.css new file mode 100644 index 0000000000..e5ea31c405 --- /dev/null +++ b/docs/5.3/examples/checkout/checkout.css @@ -0,0 +1,3 @@ +.container { + max-width: 960px; +} diff --git a/docs/5.3/examples/checkout/checkout.js b/docs/5.3/examples/checkout/checkout.js new file mode 100644 index 0000000000..30ea0aa6b1 --- /dev/null +++ b/docs/5.3/examples/checkout/checkout.js @@ -0,0 +1,19 @@ +// Example starter JavaScript for disabling form submissions if there are invalid fields +(() => { + 'use strict' + + // Fetch all the forms we want to apply custom Bootstrap validation styles to + const forms = document.querySelectorAll('.needs-validation') + + // Loop over them and prevent submission + Array.from(forms).forEach(form => { + form.addEventListener('submit', event => { + if (!form.checkValidity()) { + event.preventDefault() + event.stopPropagation() + } + + form.classList.add('was-validated') + }, false) + }) +})() diff --git a/docs/5.3/examples/checkout/index.html b/docs/5.3/examples/checkout/index.html new file mode 100644 index 0000000000..7d4f8491f4 --- /dev/null +++ b/docs/5.3/examples/checkout/index.html @@ -0,0 +1,316 @@ + + + + + + + + + Checkout example · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ +

Checkout form

+

Below is an example form built entirely with Bootstrap’s form controls. Each required form group has a validation state that can be triggered by attempting to submit the form without completing it.

+
+ +
+
+

+ Your cart + 3 +

+
    +
  • +
    +
    Product name
    + Brief description +
    + $12 +
    • +
  • +
    +
    Second product
    + Brief description +
    + $8 +
    • +
  • +
    +
    Third item
    + Brief description +
    + $5 +
    • +
  • +
    +
    Promo code
    + EXAMPLECODE +
    + −$5 +
    • +
  • + Total (USD) + $20 +
    • +
+ +
+
+ + +
+
+
+
+

Billing address

+
+
+
+ + +
+ Valid first name is required. +
+
+ +
+ + +
+ Valid last name is required. +
+
+ +
+ +
+ @ + +
+ Your username is required. +
+
+
+ +
+ + +
+ Please enter a valid email address for shipping updates. +
+
+ +
+ + +
+ Please enter your shipping address. +
+
+ +
+ + +
+ +
+ + +
+ Please select a valid country. +
+
+ +
+ + +
+ Please provide a valid state. +
+
+ +
+ + +
+ Zip code required. +
+
+
+ +
+ +
+ + +
+ +
+ + +
+ +
+ +

Payment

+ +
+
+ + +
+
+ + +
+
+ + +
+
+ +
+
+ + + Full name as displayed on card +
+ Name on card is required +
+
+ +
+ + +
+ Credit card number is required +
+
+ +
+ + +
+ Expiration date required +
+
+ +
+ + +
+ Security code required +
+
+
+ +
+ + +
+
+
+
+ + +
+ + + + + + + diff --git a/docs/5.3/examples/cover/cover.css b/docs/5.3/examples/cover/cover.css new file mode 100644 index 0000000000..2e7aef8f88 --- /dev/null +++ b/docs/5.3/examples/cover/cover.css @@ -0,0 +1,50 @@ +/* + * Globals + */ + + +/* Custom default button */ +.btn-light, +.btn-light:hover, +.btn-light:focus { + color: #333; + text-shadow: none; /* Prevent inheritance from `body` */ +} + + +/* + * Base structure + */ + +body { + text-shadow: 0 .05rem .1rem rgba(0, 0, 0, .5); + box-shadow: inset 0 0 5rem rgba(0, 0, 0, .5); +} + +.cover-container { + max-width: 42em; +} + + +/* + * Header + */ + +.nav-masthead .nav-link { + color: rgba(255, 255, 255, .5); + border-bottom: .25rem solid transparent; +} + +.nav-masthead .nav-link:hover, +.nav-masthead .nav-link:focus { + border-bottom-color: rgba(255, 255, 255, .25); +} + +.nav-masthead .nav-link + .nav-link { + margin-left: 1rem; +} + +.nav-masthead .active { + color: #fff; + border-bottom-color: #fff; +} diff --git a/docs/5.3/examples/cover/index.html b/docs/5.3/examples/cover/index.html new file mode 100644 index 0000000000..3ef86dde17 --- /dev/null +++ b/docs/5.3/examples/cover/index.html @@ -0,0 +1,116 @@ + + + + + + + + + Cover Template · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+

Cover

+ +
+
+ +
+

Cover your page.

+

Cover is a one-page template for building simple and beautiful home pages. Download, edit the text, and add your own fullscreen background photo to make it your own.

+

+ Learn more +

+
+ + +
+ + + + + diff --git a/docs/5.3/examples/dashboard-rtl/dashboard.js b/docs/5.3/examples/dashboard-rtl/dashboard.js new file mode 100644 index 0000000000..96e0895bf2 --- /dev/null +++ b/docs/5.3/examples/dashboard-rtl/dashboard.js @@ -0,0 +1,53 @@ +/* globals Chart:false, feather:false */ + +(() => { + 'use strict' + + feather.replace({ 'aria-hidden': 'true' }) + + // Graphs + const ctx = document.getElementById('myChart') + // eslint-disable-next-line no-unused-vars + const myChart = new Chart(ctx, { + type: 'line', + data: { + labels: [ + 'الأحد', + 'الإثنين', + 'الثلاثاء', + 'الأربعاء', + 'الخميس', + 'الجمعة', + 'السبت' + ], + datasets: [{ + data: [ + 15339, + 21345, + 18483, + 24003, + 23489, + 24092, + 12034 + ], + lineTension: 0, + backgroundColor: 'transparent', + borderColor: '#007bff', + borderWidth: 4, + pointBackgroundColor: '#007bff' + }] + }, + options: { + scales: { + yAxes: [{ + ticks: { + beginAtZero: false + } + }] + }, + legend: { + display: false + } + } + }) +})() diff --git a/docs/5.3/examples/dashboard-rtl/index.html b/docs/5.3/examples/dashboard-rtl/index.html new file mode 100644 index 0000000000..f75a1d3c58 --- /dev/null +++ b/docs/5.3/examples/dashboard-rtl/index.html @@ -0,0 +1,333 @@ + + + + + + + + + قالب لوحة القيادة · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ اسم الشركة + + +
+
+ تسجيل الخروج +
+
+
+ +
+
+ + +
+
+

لوحة القيادة

+
+
+ + +
+ +
+
+ + + +

عنوان القسم

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#عنوانعنوانعنوانعنوان
1,001بياناتعشوائيةتثريالجدول
1,002تثريمبهةتصميمتنسيق
1,003عشوائيةغنيةقيمةمفيدة
1,003معلوماتتثريتوضيحيةعشوائية
1,004الجدولبياناتتنسيققيمة
1,005قيمةمبهةالجدولتثري
1,006قيمةتوضيحيةغنيةعشوائية
1,007تثريمفيدةمعلوماتمبهة
1,008بياناتعشوائيةتثريالجدول
1,009تثريمبهةتصميمتنسيق
1,010عشوائيةغنيةقيمةمفيدة
1,011معلوماتتثريتوضيحيةعشوائية
1,012الجدولتثريتنسيققيمة
1,013قيمةمبهةالجدولتصميم
1,014قيمةتوضيحيةغنيةعشوائية
1,015بياناتمفيدةمعلوماتالجدول
+
+
+
+
+ + + + + + + diff --git a/docs/5.3/examples/dashboard/dashboard.css b/docs/5.3/examples/dashboard/dashboard.css new file mode 100644 index 0000000000..ad12048e76 --- /dev/null +++ b/docs/5.3/examples/dashboard/dashboard.css @@ -0,0 +1,92 @@ +body { + font-size: .875rem; +} + +.feather { + width: 16px; + height: 16px; +} + +/* + * Sidebar + */ + +.sidebar { + position: fixed; + top: 0; + /* rtl:raw: + right: 0; + */ + bottom: 0; + /* rtl:remove */ + left: 0; + z-index: 100; /* Behind the navbar */ + padding: 48px 0 0; /* Height of navbar */ + box-shadow: inset -1px 0 0 rgba(0, 0, 0, .1); +} + +@media (max-width: 767.98px) { + .sidebar { + top: 5rem; + } +} + +.sidebar-sticky { + height: calc(100vh - 48px); + overflow-x: hidden; + overflow-y: auto; /* Scrollable contents if viewport is shorter than content. */ +} + +.sidebar .nav-link { + font-weight: 500; + color: #333; +} + +.sidebar .nav-link .feather { + margin-right: 4px; + color: #727272; +} + +.sidebar .nav-link.active { + color: #2470dc; +} + +.sidebar .nav-link:hover .feather, +.sidebar .nav-link.active .feather { + color: inherit; +} + +.sidebar-heading { + font-size: .75rem; +} + +/* + * Navbar + */ + +.navbar-brand { + padding-top: .75rem; + padding-bottom: .75rem; + background-color: rgba(0, 0, 0, .25); + box-shadow: inset -1px 0 0 rgba(0, 0, 0, .25); +} + +.navbar .navbar-toggler { + top: .25rem; + right: 1rem; +} + +.navbar .form-control { + padding: .75rem 1rem; +} + +.form-control-dark { + color: #fff; + background-color: rgba(255, 255, 255, .1); + border-color: rgba(255, 255, 255, .1); +} + +.form-control-dark:focus { + border-color: transparent; + box-shadow: 0 0 0 3px rgba(255, 255, 255, .25); +} diff --git a/docs/5.3/examples/dashboard/dashboard.js b/docs/5.3/examples/dashboard/dashboard.js new file mode 100644 index 0000000000..e1379758b2 --- /dev/null +++ b/docs/5.3/examples/dashboard/dashboard.js @@ -0,0 +1,53 @@ +/* globals Chart:false, feather:false */ + +(() => { + 'use strict' + + feather.replace({ 'aria-hidden': 'true' }) + + // Graphs + const ctx = document.getElementById('myChart') + // eslint-disable-next-line no-unused-vars + const myChart = new Chart(ctx, { + type: 'line', + data: { + labels: [ + 'Sunday', + 'Monday', + 'Tuesday', + 'Wednesday', + 'Thursday', + 'Friday', + 'Saturday' + ], + datasets: [{ + data: [ + 15339, + 21345, + 18483, + 24003, + 23489, + 24092, + 12034 + ], + lineTension: 0, + backgroundColor: 'transparent', + borderColor: '#007bff', + borderWidth: 4, + pointBackgroundColor: '#007bff' + }] + }, + options: { + scales: { + yAxes: [{ + ticks: { + beginAtZero: false + } + }] + }, + legend: { + display: false + } + } + }) +})() diff --git a/docs/5.3/examples/dashboard/dashboard.rtl.css b/docs/5.3/examples/dashboard/dashboard.rtl.css new file mode 100644 index 0000000000..31ea3cc64e --- /dev/null +++ b/docs/5.3/examples/dashboard/dashboard.rtl.css @@ -0,0 +1,88 @@ +body { + font-size: .875rem; +} + +.feather { + width: 16px; + height: 16px; +} + +/* + * Sidebar + */ + +.sidebar { + position: fixed; + top: 0; + right: 0; + bottom: 0; + z-index: 100; /* Behind the navbar */ + padding: 48px 0 0; /* Height of navbar */ + box-shadow: inset 1px 0 0 rgba(0, 0, 0, .1); +} + +@media (max-width: 767.98px) { + .sidebar { + top: 5rem; + } +} + +.sidebar-sticky { + height: calc(100vh - 48px); + overflow-x: hidden; + overflow-y: auto; /* Scrollable contents if viewport is shorter than content. */ +} + +.sidebar .nav-link { + font-weight: 500; + color: #333; +} + +.sidebar .nav-link .feather { + margin-left: 4px; + color: #727272; +} + +.sidebar .nav-link.active { + color: #2470dc; +} + +.sidebar .nav-link:hover .feather, +.sidebar .nav-link.active .feather { + color: inherit; +} + +.sidebar-heading { + font-size: .75rem; +} + +/* + * Navbar + */ + +.navbar-brand { + padding-top: .75rem; + padding-bottom: .75rem; + background-color: rgba(0, 0, 0, .25); + box-shadow: inset 1px 0 0 rgba(0, 0, 0, .25); +} + +.navbar .navbar-toggler { + top: .25rem; + left: 1rem; +} + +.navbar .form-control { + padding: .75rem 1rem; +} + +.form-control-dark { + color: #fff; + background-color: rgba(255, 255, 255, .1); + border-color: rgba(255, 255, 255, .1); +} + +.form-control-dark:focus { + border-color: transparent; + box-shadow: 0 0 0 3px rgba(255, 255, 255, .25); +} diff --git a/docs/5.3/examples/dashboard/index.html b/docs/5.3/examples/dashboard/index.html new file mode 100644 index 0000000000..8515b4af82 --- /dev/null +++ b/docs/5.3/examples/dashboard/index.html @@ -0,0 +1,333 @@ + + + + + + + + + Dashboard Template · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Company name + + +
+
+ Sign out +
+
+
+ +
+
+ + +
+
+

Dashboard

+
+
+ + +
+ +
+
+ + + +

Section title

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#HeaderHeaderHeaderHeader
1,001randomdataplaceholdertext
1,002placeholderirrelevantvisuallayout
1,003datarichdashboardtabular
1,003informationplaceholderillustrativedata
1,004textrandomlayoutdashboard
1,005dashboardirrelevanttextplaceholder
1,006dashboardillustrativerichdata
1,007placeholdertabularinformationirrelevant
1,008randomdataplaceholdertext
1,009placeholderirrelevantvisuallayout
1,010datarichdashboardtabular
1,011informationplaceholderillustrativedata
1,012textplaceholderlayoutdashboard
1,013dashboardirrelevanttextvisual
1,014dashboardillustrativerichdata
1,015randomtabularinformationtext
+
+
+
+
+ + + + + + + diff --git a/docs/5.3/examples/dropdowns/dropdowns.css b/docs/5.3/examples/dropdowns/dropdowns.css new file mode 100644 index 0000000000..556f310a9d --- /dev/null +++ b/docs/5.3/examples/dropdowns/dropdowns.css @@ -0,0 +1,79 @@ +.dropdown-menu { + margin: 4rem auto; +} + +.dropdown-item-danger { + color: var(--bs-red); +} +.dropdown-item-danger:hover, +.dropdown-item-danger:focus { + color: #fff; + background-color: var(--bs-red); +} +.dropdown-item-danger.active { + background-color: var(--bs-red); +} + +.btn-hover-light { + background-color: var(--bs-white); +} +.btn-hover-light:hover, +.btn-hover-light:focus { + color: var(--bs-blue); + background-color: var(--bs-light); +} + +.cal-month, +.cal-days, +.cal-weekdays { + display: grid; + grid-template-columns: repeat(7, 1fr); + align-items: center; +} +.cal-month-name { + grid-column-start: 2; + grid-column-end: 7; + text-align: center; +} +.cal-weekday, +.cal-btn { + display: flex; + flex-shrink: 0; + align-items: center; + justify-content: center; + height: 3rem; + padding: 0; +} +.cal-btn:not([disabled]) { + font-weight: 500; +} +.cal-btn:hover, +.cal-btn:focus { + background-color: rgba(0, 0, 0, .05); +} +.cal-btn[disabled] { + border: 0; + opacity: .5; +} + +.form-control-dark { + background-color: rgba(255, 255, 255, .05); + border-color: rgba(255, 255, 255, .15); +} + + +.w-220px { + width: 220px; +} + +.w-280px { + width: 280px; +} + +.w-340px { + width: 340px; +} + +.w-600px { + width: 600px; +} diff --git a/docs/5.3/examples/dropdowns/index.html b/docs/5.3/examples/dropdowns/index.html new file mode 100644 index 0000000000..580dc56c98 --- /dev/null +++ b/docs/5.3/examples/dropdowns/index.html @@ -0,0 +1,424 @@ + + + + + + + + + Dropdowns · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Bootstrap + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+ +
+
+
+ +
+ +
+ +
+
+ +
+ +
+
+ +
+ +
+ + +
+ +
+ +
+
+
+
+ + June + + +
+
+
Sun
+
Mon
+
Tue
+
Wed
+
Thu
+
Fri
+
Sat
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +
+ +
+ +
+ ... +
+
+ + + + + + + diff --git a/docs/5.3/examples/features/features.css b/docs/5.3/examples/features/features.css new file mode 100644 index 0000000000..b5d658f6b4 --- /dev/null +++ b/docs/5.3/examples/features/features.css @@ -0,0 +1,36 @@ +.feature-icon { + width: 4rem; + height: 4rem; + border-radius: .75rem; +} + +.icon-link > .bi { + margin-top: .125rem; + margin-left: .125rem; + fill: currentcolor; + transition: transform .25s ease-in-out; +} +.icon-link:hover > .bi { + transform: translate(.25rem); +} + +.icon-square { + width: 3rem; + height: 3rem; + border-radius: .75rem; +} + +.text-shadow-1 { text-shadow: 0 .125rem .25rem rgba(0, 0, 0, .25); } +.text-shadow-2 { text-shadow: 0 .25rem .5rem rgba(0, 0, 0, .25); } +.text-shadow-3 { text-shadow: 0 .5rem 1.5rem rgba(0, 0, 0, .25); } + +.card-cover { + background-repeat: no-repeat; + background-position: center center; + background-size: cover; +} + +.feature-icon-small { + width: 3rem; + height: 3rem; +} diff --git a/docs/5.3/examples/features/index.html b/docs/5.3/examples/features/index.html new file mode 100644 index 0000000000..1af0fd7650 --- /dev/null +++ b/docs/5.3/examples/features/index.html @@ -0,0 +1,432 @@ + + + + + + + + + Features · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Bootstrap + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Features examples

+ + + +
+ +
+

Hanging icons

+
+
+
+ +
+
+

Featured title

+

Paragraph of text beneath the heading to explain the heading. We'll add onto it with another sentence and probably just keep going until we run out of words.

+ + Primary button + +
+
+
+
+ +
+
+

Featured title

+

Paragraph of text beneath the heading to explain the heading. We'll add onto it with another sentence and probably just keep going until we run out of words.

+ + Primary button + +
+
+
+
+ +
+
+

Featured title

+

Paragraph of text beneath the heading to explain the heading. We'll add onto it with another sentence and probably just keep going until we run out of words.

+ + Primary button + +
+
+
+
+ +
+ +
+

Custom cards

+ +
+
+
+
+

Short title, long jacket

+
    +
  • + Bootstrap +
    • +
  • + + Earth +
    • +
  • + + 3d +
    • +
+
+
+
+ +
+
+
+

Much longer title that wraps to multiple lines

+
    +
  • + Bootstrap +
    • +
  • + + Pakistan +
    • +
  • + + 4d +
    • +
+
+
+
+ +
+
+
+

Another longer title belongs here

+
    +
  • + Bootstrap +
    • +
  • + + California +
    • +
  • + + 5d +
    • +
+
+
+
+
+
+ +
+ +
+

Icon grid

+ +
+
+ +
+

Featured title

+

Paragraph of text beneath the heading to explain the heading.

+
+
+
+ +
+

Featured title

+

Paragraph of text beneath the heading to explain the heading.

+
+
+
+ +
+

Featured title

+

Paragraph of text beneath the heading to explain the heading.

+
+
+
+ +
+

Featured title

+

Paragraph of text beneath the heading to explain the heading.

+
+
+
+ +
+

Featured title

+

Paragraph of text beneath the heading to explain the heading.

+
+
+
+ +
+

Featured title

+

Paragraph of text beneath the heading to explain the heading.

+
+
+
+ +
+

Featured title

+

Paragraph of text beneath the heading to explain the heading.

+
+
+
+ +
+

Featured title

+

Paragraph of text beneath the heading to explain the heading.

+
+
+
+
+ +
+ +
+

Features with title

+ +
+
+

Left-aligned title explaining these awesome features

+

Paragraph of text beneath the heading to explain the heading. We'll add onto it with another sentence and probably just keep going until we run out of words.

+ Primary button +
+ +
+
+
+
+ + + +
+

Featured title

+

Paragraph of text beneath the heading to explain the heading.

+
+ +
+
+ + + +
+

Featured title

+

Paragraph of text beneath the heading to explain the heading.

+
+ +
+
+ + + +
+

Featured title

+

Paragraph of text beneath the heading to explain the heading.

+
+ +
+
+ + + +
+

Featured title

+

Paragraph of text beneath the heading to explain the heading.

+
+
+
+
+
+
+ + + + + + + diff --git a/docs/5.3/examples/features/unsplash-photo-1.jpg b/docs/5.3/examples/features/unsplash-photo-1.jpg new file mode 100644 index 0000000000..ed2e36a78d Binary files /dev/null and b/docs/5.3/examples/features/unsplash-photo-1.jpg differ diff --git a/docs/5.3/examples/features/unsplash-photo-2.jpg b/docs/5.3/examples/features/unsplash-photo-2.jpg new file mode 100644 index 0000000000..b66864a005 Binary files /dev/null and b/docs/5.3/examples/features/unsplash-photo-2.jpg differ diff --git a/docs/5.3/examples/features/unsplash-photo-3.jpg b/docs/5.3/examples/features/unsplash-photo-3.jpg new file mode 100644 index 0000000000..c411b17ec0 Binary files /dev/null and b/docs/5.3/examples/features/unsplash-photo-3.jpg differ diff --git a/docs/5.3/examples/footers/index.html b/docs/5.3/examples/footers/index.html new file mode 100644 index 0000000000..69d5095152 --- /dev/null +++ b/docs/5.3/examples/footers/index.html @@ -0,0 +1,272 @@ + + + + + + + + + Footers · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + Bootstrap + + + + + + + + + + + + + +
+ +
+ +
+ +
+
+
+ + + + © 2022 Company, Inc +
+ +
    +
    • +
    • +
    • +
+
+
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ + +
+ +
+ + + + + + + diff --git a/docs/5.3/examples/grid/grid.css b/docs/5.3/examples/grid/grid.css new file mode 100644 index 0000000000..18e3568b1b --- /dev/null +++ b/docs/5.3/examples/grid/grid.css @@ -0,0 +1,13 @@ +.themed-grid-col { + padding-top: .75rem; + padding-bottom: .75rem; + background-color: rgba(86, 61, 124, .15); + border: 1px solid rgba(86, 61, 124, .2); +} + +.themed-container { + padding: .75rem; + margin-bottom: 1.5rem; + background-color: rgba(0, 123, 255, .15); + border: 1px solid rgba(0, 123, 255, .2); +} diff --git a/docs/5.3/examples/grid/index.html b/docs/5.3/examples/grid/index.html new file mode 100644 index 0000000000..ea48780abc --- /dev/null +++ b/docs/5.3/examples/grid/index.html @@ -0,0 +1,271 @@ + + + + + + + + + Grid Template · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +

Bootstrap grid examples

+

Basic grid layouts to get you familiar with building within the Bootstrap grid system.

+

In these examples the .themed-grid-col class is added to the columns to add some theming. This is not a class that is available in Bootstrap by default.

+ +

Five grid tiers

+

There are five tiers to the Bootstrap grid system, one for each range of devices we support. Each tier starts at a minimum viewport size and automatically applies to the larger devices unless overridden.

+ +
+
.col-4
+
.col-4
+
.col-4
+
+ +
+
.col-sm-4
+
.col-sm-4
+
.col-sm-4
+
+ +
+
.col-md-4
+
.col-md-4
+
.col-md-4
+
+ +
+
.col-lg-4
+
.col-lg-4
+
.col-lg-4
+
+ +
+
.col-xl-4
+
.col-xl-4
+
.col-xl-4
+
+ +
+
.col-xxl-4
+
.col-xxl-4
+
.col-xxl-4
+
+ +

Three equal columns

+

Get three equal-width columns starting at desktops and scaling to large desktops. On mobile devices, tablets and below, the columns will automatically stack.

+
+
.col-md-4
+
.col-md-4
+
.col-md-4
+
+ +

Three equal columns alternative

+

By using the .row-cols-* classes, you can easily create a grid with equal columns.

+
+
.col child of .row-cols-md-3
+
.col child of .row-cols-md-3
+
.col child of .row-cols-md-3
+
+ +

Three unequal columns

+

Get three columns starting at desktops and scaling to large desktops of various widths. Remember, grid columns should add up to twelve for a single horizontal block. More than that, and columns start stacking no matter the viewport.

+
+
.col-md-3
+
.col-md-6
+
.col-md-3
+
+ +

Two columns

+

Get two columns starting at desktops and scaling to large desktops.

+
+
.col-md-8
+
.col-md-4
+
+ +

Full width, single column

+

+ No grid classes are necessary for full-width elements. +

+ +
+ +

Two columns with two nested columns

+

Per the documentation, nesting is easy—just put a row of columns within an existing column. This gives you two columns starting at desktops and scaling to large desktops, with another two (equal widths) within the larger column.

+

At mobile device sizes, tablets and down, these columns and their nested columns will stack.

+
+
+
+ .col-md-8 +
+
+
.col-md-6
+
.col-md-6
+
+
+
.col-md-4
+
+ +
+ +

Mixed: mobile and desktop

+

The Bootstrap v5 grid system has six tiers of classes: xs (extra small, this class infix is not used), sm (small), md (medium), lg (large), xl (x-large), and xxl (xx-large). You can use nearly any combination of these classes to create more dynamic and flexible layouts.

+

Each tier of classes scales up, meaning if you plan on setting the same widths for md, lg, xl and xxl, you only need to specify md.

+
+
.col-md-8
+
.col-6 .col-md-4
+
+
+
.col-6 .col-md-4
+
.col-6 .col-md-4
+
.col-6 .col-md-4
+
+
+
.col-6
+
.col-6
+
+ +
+ +

Mixed: mobile, tablet, and desktop

+
+
.col-sm-6 .col-lg-8
+
.col-6 .col-lg-4
+
+
+
.col-6 .col-sm-4
+
.col-6 .col-sm-4
+
.col-6 .col-sm-4
+
+ +
+ +

Gutters

+

With .gx-* classes, the horizontal gutters can be adjusted.

+
+
.col with .gx-4 gutters
+
.col with .gx-4 gutters
+
.col with .gx-4 gutters
+
.col with .gx-4 gutters
+
.col with .gx-4 gutters
+
.col with .gx-4 gutters
+
+

Use the .gy-* classes to control the vertical gutters.

+
+
.col with .gy-4 gutters
+
.col with .gy-4 gutters
+
.col with .gy-4 gutters
+
.col with .gy-4 gutters
+
.col with .gy-4 gutters
+
.col with .gy-4 gutters
+
+

With .g-* classes, the gutters in both directions can be adjusted.

+
+
.col with .g-3 gutters
+
.col with .g-3 gutters
+
.col with .g-3 gutters
+
.col with .g-3 gutters
+
.col with .g-3 gutters
+
.col with .g-3 gutters
+
+
+ +
+
+ +

Containers

+

Additional classes added in Bootstrap v4.4 allow containers that are 100% wide until a particular breakpoint. v5 adds a new xxl breakpoint.

+
+ +
.container
+
.container-sm
+
.container-md
+
.container-lg
+
.container-xl
+
.container-xxl
+
.container-fluid
+
+ + + + + diff --git a/docs/5.3/examples/headers/headers.css b/docs/5.3/examples/headers/headers.css new file mode 100644 index 0000000000..8230c9a5f5 --- /dev/null +++ b/docs/5.3/examples/headers/headers.css @@ -0,0 +1,15 @@ +.form-control-dark { + border-color: var(--bs-gray); +} +.form-control-dark:focus { + border-color: #fff; + box-shadow: 0 0 0 .25rem rgba(255, 255, 255, .25); +} + +.text-small { + font-size: 85%; +} + +.dropdown-toggle { + outline: 0; +} diff --git a/docs/5.3/examples/headers/index.html b/docs/5.3/examples/headers/index.html new file mode 100644 index 0000000000..1ac61b11ee --- /dev/null +++ b/docs/5.3/examples/headers/index.html @@ -0,0 +1,381 @@ + + + + + + + + + Headers · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Bootstrap + + + + + + + + + + + + + + + + + + + + + +
+

Headers examples

+ +
+
+ + + Simple header + + + +
+
+ +
+ +
+
+ +
+
+ +
+ +
+
+ + + + + + +
+ + +
+
+
+ +
+ +
+
+
+ + + + + + + + +
+ + +
+
+
+
+ +
+ +
+
+
+ + + + + + + + +
+ + +
+
+
+
+ +
+ +
+
+
+ + +
+ +
+ + +
+ + +
+
+
+
+ +
+
+
+









+
+
+









+
+
+
+ +
+ + +
+
+ + + Double header + + +
+
+ +
+ +
+
+
+
+ + + + + +
+
+
+
+
+ + +
+ + +
+
+
+
+ +
+
+ + + + + + + diff --git a/docs/5.3/examples/heroes/bootstrap-docs.png b/docs/5.3/examples/heroes/bootstrap-docs.png new file mode 100644 index 0000000000..471a9eddfe Binary files /dev/null and b/docs/5.3/examples/heroes/bootstrap-docs.png differ diff --git a/docs/5.3/examples/heroes/bootstrap-themes.png b/docs/5.3/examples/heroes/bootstrap-themes.png new file mode 100644 index 0000000000..13c32337d6 Binary files /dev/null and b/docs/5.3/examples/heroes/bootstrap-themes.png differ diff --git a/docs/5.3/examples/heroes/heroes.css b/docs/5.3/examples/heroes/heroes.css new file mode 100644 index 0000000000..e9deaf744f --- /dev/null +++ b/docs/5.3/examples/heroes/heroes.css @@ -0,0 +1,3 @@ +@media (min-width: 992px) { + .rounded-lg-3 { border-radius: .3rem; } +} diff --git a/docs/5.3/examples/heroes/index.html b/docs/5.3/examples/heroes/index.html new file mode 100644 index 0000000000..f05d99a0d2 --- /dev/null +++ b/docs/5.3/examples/heroes/index.html @@ -0,0 +1,211 @@ + + + + + + + + + Heroes · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Heroes examples

+ +
+ +

Centered hero

+
+

Quickly design and customize responsive mobile-first sites with Bootstrap, the world’s most popular front-end open source toolkit, featuring Sass variables and mixins, responsive grid system, extensive prebuilt components, and powerful JavaScript plugins.

+
+ + +
+
+
+ +
+ +
+

Centered screenshot

+
+

Quickly design and customize responsive mobile-first sites with Bootstrap, the world’s most popular front-end open source toolkit, featuring Sass variables and mixins, responsive grid system, extensive prebuilt components, and powerful JavaScript plugins.

+
+ + +
+
+
+
+ Example image +
+
+
+ +
+ +
+
+
+ Bootstrap Themes +
+
+

Responsive left-aligned hero with image

+

Quickly design and customize responsive mobile-first sites with Bootstrap, the world’s most popular front-end open source toolkit, featuring Sass variables and mixins, responsive grid system, extensive prebuilt components, and powerful JavaScript plugins.

+
+ + +
+
+
+
+ +
+ +
+
+
+

Vertically centered hero sign-up form

+

Below is an example form built entirely with Bootstrap’s form controls. Each required form group has a validation state that can be triggered by attempting to submit the form without completing it.

+
+
+
+
+ + +
+
+ + +
+
+ +
+ +
+ By clicking Sign up, you agree to the terms of use. +
+
+
+
+ +
+ +
+
+
+

Border hero with cropped image and shadows

+

Quickly design and customize responsive mobile-first sites with Bootstrap, the world’s most popular front-end open source toolkit, featuring Sass variables and mixins, responsive grid system, extensive prebuilt components, and powerful JavaScript plugins.

+
+ + +
+
+
+ +
+
+
+ +
+ +
+
+

Dark mode hero

+
+

Quickly design and customize responsive mobile-first sites with Bootstrap, the world’s most popular front-end open source toolkit, featuring Sass variables and mixins, responsive grid system, extensive prebuilt components, and powerful JavaScript plugins.

+
+ + +
+
+
+
+ +
+
+ + + + + + + diff --git a/docs/5.3/examples/index.html b/docs/5.3/examples/index.html new file mode 100644 index 0000000000..f227699832 --- /dev/null +++ b/docs/5.3/examples/index.html @@ -0,0 +1,997 @@ + + + + + + + + + + + + +Examples · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+
+
+
+

Examples

+

Quickly get a project started with any of our examples ranging from using parts of the framework to custom components and layouts.

+ +
+ + + Download examples + + + Download source code + +
+ +
+
+ + +
+
+
+
+ +
+
+ +
+
+

Snippets

+

Common patterns for building sites and apps that build on existing components and utilities with custom CSS and more.

+
+ +
+
+
+ + +

Headers

+ +

Display your branding, navigation, search, and more with these header components

+
+ + +
+ + +

Heroes

+ +

Set the stage on your homepage with heroes that feature clear calls to action.

+
+ + +
+ + +

Features

+ +

Explain the features, benefits, or other details in your marketing content.

+
+ + +
+ + +

Sidebars

+ +

Common navigation patterns ideal for offcanvas or multi-column layouts.

+
+ + +
+ + +

Footers

+ +

Finish every page strong with an awesome footer, big or small.

+
+ + +
+ + +

Dropdowns

+ +

Enhance your dropdowns with filters, icons, custom styles, and more.

+
+ + +
+ + +

List groups

+ +

Extend list groups with utilities and custom styles for any content.

+
+ + +
+ + +

Modals

+ +

Transform modals to serve any purpose, from feature tours to dialogs.

+
+
+
+
+
+
+

Custom Components

+

Brand-new components and templates to help folks quickly get started with Bootstrap and demonstrate best practices for adding onto the framework.

+
+ +
+
+
+ + +

Album

+ +

Simple one-page template for photo galleries, portfolios, and more.

+
+ + +
+ + +

Pricing

+ +

Example pricing page built with Cards and featuring a custom header and footer.

+
+ + +
+ + +

Checkout

+ +

Custom checkout form showing our form components and their validation features.

+
+ + +
+ + +

Product

+ +

Lean product-focused marketing page with extensive grid and image work.

+
+ + +
+ + +

Cover

+ +

A one-page template for building simple and beautiful home pages.

+
+ + +
+ + +

Carousel

+ +

Customize the navbar and carousel, then add some new components.

+
+ + +
+ + +

Blog

+ +

Magazine like blog template with header, navigation, featured content.

+
+ + +
+ + +

Dashboard

+ +

Basic admin dashboard shell with fixed sidebar and navbar.

+
+ + +
+ + +

Sign-in

+ +

Custom form layout and design for a simple sign in form.

+
+ + +
+ + +

Sticky footer

+ +

Attach a footer to the bottom of the viewport when page content is short.

+
+ + +
+ + +

Sticky footer navbar

+ +

Attach a footer to the bottom of the viewport with a fixed top navbar.

+
+ + +
+ + +

Jumbotron

+ +

Use utilities to recreate and enhance Bootstrap 4's jumbotron.

+
+
+
+
+
+
+

Framework

+

Examples that focus on implementing uses of built-in components provided by Bootstrap.

+
+ +
+
+
+ + +

Starter template

+ +

Nothing but the basics: compiled CSS and JavaScript.

+
+ + +
+ + +

Grid

+ +

Multiple examples of grid layouts with all four tiers, nesting, and more.

+
+ + +
+ + +

Cheatsheet

+ +

Kitchen sink of Bootstrap components.

+
+ + +
+ + +

Cheatsheet RTL

+ +

Kitchen sink of Bootstrap components, RTL.

+
+
+
+
+
+
+ +

Taking the default navbar component and showing how it can be moved, placed, and extended.

+
+ +
+
+
+ + +

Navbars

+ +

Demonstration of all responsive and container options for the navbar.

+
+ + +
+ + +

Navbars offcanvas

+ +

Same as the Navbars example, but with our offcanvas component.

+
+ + +
+ + +

Navbar static

+ +

Single navbar example of a static top navbar along with some additional content.

+
+ + +
+ + +

Navbar fixed

+ +

Single navbar example with a fixed top navbar along with some additional content.

+
+ + +
+ + +

Navbar bottom

+ +

Single navbar example with a bottom navbar along with some additional content.

+
+ + +
+ + +

Offcanvas navbar

+ +

Turn your expandable navbar into a sliding offcanvas menu (doesn't use our offcanvas component).

+
+
+
+
+
+
+

RTL

+

See Bootstrap's RTL version in action with these modified Custom Components examples.

+
+

+ RTL is still experimental and will evolve with feedback. Spotted something or have an improvement to suggest? +

+

Please open an issue.

+
+
+ +
+
+
+ + +

Album RTL

+ +

Simple one-page template for photo galleries, portfolios, and more.

+
+ + +
+ + +

Checkout RTL

+ +

Custom checkout form showing our form components and their validation features.

+
+ + +
+ + +

Carousel RTL

+ +

Customize the navbar and carousel, then add some new components.

+
+ + +
+ + +

Blog RTL

+ +

Magazine like blog template with header, navigation, featured content.

+
+ + +
+ + +

Dashboard RTL

+ +

Basic admin dashboard shell with fixed sidebar and navbar.

+
+
+
+
+
+
+

Integrations

+

Integrations with external libraries.

+
+ +
+
+
+ + +

Masonry

+ +

Combine the powers of the Bootstrap grid and the Masonry layout.

+
+
+
+
+ + + + +
+
+
+
+ + + + +
+

Go further with Bootstrap Themes

+

+ Need something more than these examples? Take Bootstrap to the next level with premium themes from the official Bootstrap Themes marketplace. They’re built as their own extended frameworks, rich with new components and plugins, documentation, and powerful build tools. +

+ Browse themes +
+ Bootstrap Themes +
+ +
+
+ + + + + + + + + + + + + + + + + + diff --git a/docs/5.3/examples/jumbotron/index.html b/docs/5.3/examples/jumbotron/index.html new file mode 100644 index 0000000000..ff6174f2de --- /dev/null +++ b/docs/5.3/examples/jumbotron/index.html @@ -0,0 +1,129 @@ + + + + + + + + + Jumbotron example · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + Bootstrap + Jumbotron example + +
+ +
+
+

Custom jumbotron

+

Using a series of utilities, you can create this jumbotron, just like the one in previous versions of Bootstrap. Check out the examples below for how you can remix and restyle it to your liking.

+ +
+
+ +
+
+
+

Change the background

+

Swap the background-color utility and add a `.text-*` color utility to mix up the jumbotron look. Then, mix and match with additional component themes and more.

+ +
+
+
+
+

Add borders

+

Or, keep it light and add a border for some added definition to the boundaries of your content. Be sure to look under the hood at the source HTML here as we've adjusted the alignment and sizing of both column's content for equal-height.

+ +
+
+
+ +
+ © 2022 +
+
+
+ + + + + diff --git a/docs/5.3/examples/list-groups/index.html b/docs/5.3/examples/list-groups/index.html new file mode 100644 index 0000000000..4efba5a6c9 --- /dev/null +++ b/docs/5.3/examples/list-groups/index.html @@ -0,0 +1,308 @@ + + + + + + + + + List groups · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Bootstrap + + + + + + + + + + + + + + + + + + +
+ + twbs +
+
+
List group item heading
+

Some placeholder content in a paragraph.

+
+ now +
+ + + twbs +
+
+
Another title here
+

Some placeholder content in a paragraph that goes a little longer so it wraps to a new line.

+
+ 3d +
+ + + twbs +
+
+
Third heading
+

Some placeholder content in a paragraph.

+
+ 1w +
+ +
+ +
+ +
+
+ + + +
+ +
+ + + +
+
+ +
+ +
+ + + + +
+ +
+ +
+ + + + + + + + + + + +
+ +
+ +
+
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+
+ + + + + + + diff --git a/docs/5.3/examples/list-groups/list-groups.css b/docs/5.3/examples/list-groups/list-groups.css new file mode 100644 index 0000000000..218508412b --- /dev/null +++ b/docs/5.3/examples/list-groups/list-groups.css @@ -0,0 +1,61 @@ +.list-group { + max-width: 460px; + margin: 4rem auto; +} + +.form-check-input:checked + .form-checked-content { + opacity: .5; +} + +.form-check-input-placeholder { + border-style: dashed; +} +[contenteditable]:focus { + outline: 0; +} + +.list-group-checkable .list-group-item { + cursor: pointer; +} +.list-group-item-check { + position: absolute; + clip: rect(0, 0, 0, 0); +} +.list-group-item-check:hover + .list-group-item { + background-color: var(--bs-light); +} +.list-group-item-check:checked + .list-group-item { + color: #fff; + background-color: var(--bs-blue); +} +.list-group-item-check[disabled] + .list-group-item, +.list-group-item-check:disabled + .list-group-item { + pointer-events: none; + filter: none; + opacity: .5; +} + +.list-group-radio .list-group-item { + cursor: pointer; + border-radius: .5rem; +} +.list-group-radio .form-check-input { + z-index: 2; + margin-top: -.5em; +} +.list-group-radio .list-group-item:hover, +.list-group-radio .list-group-item:focus { + background-color: var(--bs-light); +} + +.list-group-radio .form-check-input:checked + .list-group-item { + background-color: var(--bs-body); + border-color: var(--bs-blue); + box-shadow: 0 0 0 2px var(--bs-blue); +} +.list-group-radio .form-check-input[disabled] + .list-group-item, +.list-group-radio .form-check-input:disabled + .list-group-item { + pointer-events: none; + filter: none; + opacity: .5; +} diff --git a/docs/5.3/examples/masonry/index.html b/docs/5.3/examples/masonry/index.html new file mode 100644 index 0000000000..ac6b353692 --- /dev/null +++ b/docs/5.3/examples/masonry/index.html @@ -0,0 +1,188 @@ + + + + + + + + + Masonry example · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Bootstrap and Masonry

+

Integrate Masonry with the Bootstrap grid system and cards component.

+ +

Masonry is not included in Bootstrap. Add it by including the JavaScript plugin manually, or using a CDN like so:

+ + 

+<script src="https://cdn.jsdelivr.net/npm/masonry-layout@4.2.2/dist/masonry.pkgd.min.js" integrity="sha384-GNFwBvfVxBkLMJpYMOABq3c+d3KnQxudP/mGPkzpZSTYykLBNsZEnG2D9G/X/+7D" crossorigin="anonymous" async></script>
+
+ +

By adding data-masonry='{"percentPosition": true }' to the .row wrapper, we can combine the powers of Bootstrap's responsive grid and Masonry's positioning.

+ +
+ +
+
+
+ PlaceholderImage cap +
+
Card title that wraps to a new line
+

This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

+
+
+
+
+
+
+
+

A well-known quote, contained in a blockquote element.

+
+
+ Someone famous in Source Title +
+
+
+
+
+
+ PlaceholderImage cap +
+
Card title
+

This card has supporting text below as a natural lead-in to additional content.

+

Last updated 3 mins ago

+
+
+
+
+
+
+
+

A well-known quote, contained in a blockquote element.

+
+
+ Someone famous in Source Title +
+
+
+
+
+
+
+
Card title
+

This card has a regular title and short paragraph of text below it.

+

Last updated 3 mins ago

+
+
+
+
+
+ PlaceholderCard image +
+
+
+
+
+
+

A well-known quote, contained in a blockquote element.

+
+
+ Someone famous in Source Title +
+
+
+
+
+
+
+
Card title
+

This is another card with title and supporting text below. This card has some additional content to make it slightly taller overall.

+

Last updated 3 mins ago

+
+
+
+
+ +
+ + + + + + + diff --git a/docs/5.3/examples/modals/index.html b/docs/5.3/examples/modals/index.html new file mode 100644 index 0000000000..0aa5985817 --- /dev/null +++ b/docs/5.3/examples/modals/index.html @@ -0,0 +1,259 @@ + + + + + + + + + Modals · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Bootstrap + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+ + + +
+ + + + + + + diff --git a/docs/5.3/examples/modals/modals.css b/docs/5.3/examples/modals/modals.css new file mode 100644 index 0000000000..51ad2c4fb7 --- /dev/null +++ b/docs/5.3/examples/modals/modals.css @@ -0,0 +1,15 @@ +.modal-sheet .modal-dialog { + width: 380px; + transition: bottom .75s ease-in-out; +} +.modal-sheet .modal-footer { + padding-bottom: 2rem; +} + +.modal-alert .modal-dialog { + width: 380px; +} + +.modal-tour .modal-dialog { + width: 380px; +} diff --git a/docs/5.3/examples/navbar-bottom/index.html b/docs/5.3/examples/navbar-bottom/index.html new file mode 100644 index 0000000000..062efe5d7e --- /dev/null +++ b/docs/5.3/examples/navbar-bottom/index.html @@ -0,0 +1,128 @@ + + + + + + + + + Bottom navbar example · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+

Bottom Navbar example

+

This example is a quick exercise to illustrate how the bottom navbar works.

+ View navbar docs » +
+
+ + + + + + + + diff --git a/docs/5.3/examples/navbar-fixed/index.html b/docs/5.3/examples/navbar-fixed/index.html new file mode 100644 index 0000000000..4006f0e6ba --- /dev/null +++ b/docs/5.3/examples/navbar-fixed/index.html @@ -0,0 +1,127 @@ + + + + + + + + + Fixed top navbar example · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+

Navbar example

+

This example is a quick exercise to illustrate how fixed to top navbar works. As you scroll, it will remain fixed to the top of your browser’s viewport.

+ View navbar docs » +
+
+ + + + + + + diff --git a/docs/5.3/examples/navbar-fixed/navbar-fixed.css b/docs/5.3/examples/navbar-fixed/navbar-fixed.css new file mode 100644 index 0000000000..c77c0c1475 --- /dev/null +++ b/docs/5.3/examples/navbar-fixed/navbar-fixed.css @@ -0,0 +1,5 @@ +/* Show it is fixed to the top */ +body { + min-height: 75rem; + padding-top: 4.5rem; +} diff --git a/docs/5.3/examples/navbar-static/index.html b/docs/5.3/examples/navbar-static/index.html new file mode 100644 index 0000000000..33ce65f24c --- /dev/null +++ b/docs/5.3/examples/navbar-static/index.html @@ -0,0 +1,127 @@ + + + + + + + + + Top navbar example · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+

Navbar example

+

This example is a quick exercise to illustrate how the top-aligned navbar works. As you scroll, this navbar remains in its original position and moves with the rest of the page.

+ View navbar docs » +
+
+ + + + + + + diff --git a/docs/5.3/examples/navbar-static/navbar-static.css b/docs/5.3/examples/navbar-static/navbar-static.css new file mode 100644 index 0000000000..25bbdde094 --- /dev/null +++ b/docs/5.3/examples/navbar-static/navbar-static.css @@ -0,0 +1,4 @@ +/* Show it's not fixed to the top */ +body { + min-height: 75rem; +} diff --git a/docs/5.3/examples/navbars-offcanvas/index.html b/docs/5.3/examples/navbars-offcanvas/index.html new file mode 100644 index 0000000000..f64652643b --- /dev/null +++ b/docs/5.3/examples/navbars-offcanvas/index.html @@ -0,0 +1,234 @@ + + + + + + + + + Navbar Template · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+
+

Navbar with offcanvas examples

+

This example shows how responsive offcanvas menus work within the navbar. For positioning of navbars, checkout the top and fixed top examples.

+

From the top down, you'll see a dark navbar, light navbar and a responsive navbar—each with offcanvases built in. Resize your browser window to the large breakpoint to see the toggle for the offcanvas.

+

+ Learn more about offcanvas navbars » +

+
+
+
+
+ + + + + + + diff --git a/docs/5.3/examples/navbars-offcanvas/navbars-offcanvas.css b/docs/5.3/examples/navbars-offcanvas/navbars-offcanvas.css new file mode 100644 index 0000000000..70d209409d --- /dev/null +++ b/docs/5.3/examples/navbars-offcanvas/navbars-offcanvas.css @@ -0,0 +1,7 @@ +body { + padding-bottom: 20px; +} + +.navbar { + margin-bottom: 20px; +} diff --git a/docs/5.3/examples/navbars/index.html b/docs/5.3/examples/navbars/index.html new file mode 100644 index 0000000000..31d51caff8 --- /dev/null +++ b/docs/5.3/examples/navbars/index.html @@ -0,0 +1,537 @@ + + + + + + + + + Navbar Template · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + +
+

Matching .container-xl...

+
+ + + +
+ + + + + + +
+
+
+

Navbar examples

+

This example is a quick exercise to illustrate how the navbar and its contents work. Some navbars extend the width of the viewport, others are confined within a .container. For positioning of navbars, checkout the top and fixed top examples.

+

At the smallest breakpoint, the collapse plugin is used to hide the links and show a menu button to toggle the collapsed content.

+

+ View navbar docs » +

+
+
+
+
+
+ + + + + + + diff --git a/docs/5.3/examples/navbars/navbars.css b/docs/5.3/examples/navbars/navbars.css new file mode 100644 index 0000000000..70d209409d --- /dev/null +++ b/docs/5.3/examples/navbars/navbars.css @@ -0,0 +1,7 @@ +body { + padding-bottom: 20px; +} + +.navbar { + margin-bottom: 20px; +} diff --git a/docs/5.3/examples/offcanvas-navbar/index.html b/docs/5.3/examples/offcanvas-navbar/index.html new file mode 100644 index 0000000000..cde7ae325a --- /dev/null +++ b/docs/5.3/examples/offcanvas-navbar/index.html @@ -0,0 +1,223 @@ + + + + + + + + + Offcanvas navbar template · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

Bootstrap

+ Since 2011 +
+
+ +
+
Recent updates
+
+ Placeholder32x32 +

+ @username + Some representative placeholder content, with some information about this user. Imagine this being some sort of status update, perhaps? +

+
+
+ Placeholder32x32 +

+ @username + Some more representative placeholder content, related to this other user. Another status update, perhaps. +

+
+
+ Placeholder32x32 +

+ @username + This user also gets some representative placeholder content. Maybe they did something interesting, and you really want to highlight this in the recent updates. +

+
+ + All updates + +
+ +
+
Suggestions
+
+ Placeholder32x32 +
+
+ Full Name + Follow +
+ @username +
+
+
+ Placeholder32x32 +
+
+ Full Name + Follow +
+ @username +
+
+
+ Placeholder32x32 +
+
+ Full Name + Follow +
+ @username +
+
+ + All suggestions + +
+
+ + + + + + + diff --git a/docs/5.3/examples/offcanvas-navbar/offcanvas-navbar.css b/docs/5.3/examples/offcanvas-navbar/offcanvas-navbar.css new file mode 100644 index 0000000000..f855b96a55 --- /dev/null +++ b/docs/5.3/examples/offcanvas-navbar/offcanvas-navbar.css @@ -0,0 +1,52 @@ +html, +body { + overflow-x: hidden; /* Prevent scroll on narrow devices */ +} + +body { + padding-top: 56px; +} + +@media (max-width: 991.98px) { + .offcanvas-collapse { + position: fixed; + top: 56px; /* Height of navbar */ + bottom: 0; + left: 100%; + width: 100%; + padding-right: 1rem; + padding-left: 1rem; + overflow-y: auto; + visibility: hidden; + background-color: #343a40; + transition: transform .3s ease-in-out, visibility .3s ease-in-out; + } + .offcanvas-collapse.open { + visibility: visible; + transform: translateX(-100%); + } +} + +.nav-scroller .nav { + color: rgba(255, 255, 255, .75); +} + +.nav-scroller .nav-link { + padding-top: .75rem; + padding-bottom: .75rem; + font-size: .875rem; + color: #6c757d; +} + +.nav-scroller .nav-link:hover { + color: #007bff; +} + +.nav-scroller .active { + font-weight: 500; + color: #343a40; +} + +.bg-purple { + background-color: #6f42c1; +} diff --git a/docs/5.3/examples/offcanvas-navbar/offcanvas-navbar.js b/docs/5.3/examples/offcanvas-navbar/offcanvas-navbar.js new file mode 100644 index 0000000000..b97a171648 --- /dev/null +++ b/docs/5.3/examples/offcanvas-navbar/offcanvas-navbar.js @@ -0,0 +1,7 @@ +(() => { + 'use strict' + + document.querySelector('#navbarSideCollapse').addEventListener('click', () => { + document.querySelector('.offcanvas-collapse').classList.toggle('open') + }) +})() diff --git a/docs/5.3/examples/offcanvas/index.html b/docs/5.3/examples/offcanvas/index.html new file mode 100644 index 0000000000..aa79baceba --- /dev/null +++ b/docs/5.3/examples/offcanvas/index.html @@ -0,0 +1,12 @@ + + + + + + https://getbootstrap.com/docs/5.3/examples/offcanvas-navbar/ + + + + + + diff --git a/docs/5.3/examples/pricing/index.html b/docs/5.3/examples/pricing/index.html new file mode 100644 index 0000000000..dddb74369a --- /dev/null +++ b/docs/5.3/examples/pricing/index.html @@ -0,0 +1,271 @@ + + + + + + + + + Pricing example · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Check + + + + +
+
+
+ + Bootstrap + Pricing example + + + +
+ +
+

Pricing

+

Quickly build an effective pricing table for your potential customers with this Bootstrap example. It’s built with default Bootstrap components and utilities with little customization.

+
+
+ +
+
+
+
+
+

Free

+
+
+

$0/mo

+
    +
  • 10 users included
    • +
  • 2 GB of storage
    • +
  • Email support
    • +
  • Help center access
    • +
+ +
+
+
+
+
+
+

Pro

+
+
+

$15/mo

+
    +
  • 20 users included
    • +
  • 10 GB of storage
    • +
  • Priority email support
    • +
  • Help center access
    • +
+ +
+
+
+
+
+
+

Enterprise

+
+
+

$29/mo

+
    +
  • 30 users included
    • +
  • 15 GB of storage
    • +
  • Phone and email support
    • +
  • Help center access
    • +
+ +
+
+
+
+ +

Compare plans

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FreeProEnterprise
Public
Private
Permissions
Sharing
Unlimited members
Extra security
+
+
+ + +
+ + + + + diff --git a/docs/5.3/examples/pricing/pricing.css b/docs/5.3/examples/pricing/pricing.css new file mode 100644 index 0000000000..c7304d10be --- /dev/null +++ b/docs/5.3/examples/pricing/pricing.css @@ -0,0 +1,11 @@ +body { + background-image: linear-gradient(180deg, #eee, #fff 100px, #fff); +} + +.container { + max-width: 960px; +} + +.pricing-header { + max-width: 700px; +} diff --git a/docs/5.3/examples/product/index.html b/docs/5.3/examples/product/index.html new file mode 100644 index 0000000000..6f24db056e --- /dev/null +++ b/docs/5.3/examples/product/index.html @@ -0,0 +1,235 @@ + + + + + + + + + Product example · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+

Punny headline

+

And an even wittier subheading to boot. Jumpstart your marketing efforts with this example based on Apple’s marketing pages.

+ Coming soon +
+
+
+
+ +
+
+
+

Another headline

+

And an even wittier subheading.

+
+
+
+
+
+

Another headline

+

And an even wittier subheading.

+
+
+
+
+ +
+
+
+

Another headline

+

And an even wittier subheading.

+
+
+
+
+
+

Another headline

+

And an even wittier subheading.

+
+
+
+
+ +
+
+
+

Another headline

+

And an even wittier subheading.

+
+
+
+
+
+

Another headline

+

And an even wittier subheading.

+
+
+
+
+ +
+
+
+

Another headline

+

And an even wittier subheading.

+
+
+
+
+
+

Another headline

+

And an even wittier subheading.

+
+
+
+
+
+ + + + + + + + + diff --git a/docs/5.3/examples/product/product.css b/docs/5.3/examples/product/product.css new file mode 100644 index 0000000000..5fcb582b43 --- /dev/null +++ b/docs/5.3/examples/product/product.css @@ -0,0 +1,69 @@ +.container { + max-width: 960px; +} + +/* + * Custom translucent site header + */ + +.site-header { + background-color: rgba(0, 0, 0, .85); + -webkit-backdrop-filter: saturate(180%) blur(20px); + backdrop-filter: saturate(180%) blur(20px); +} +.site-header a { + color: #8e8e8e; + transition: color .15s ease-in-out; +} +.site-header a:hover { + color: #fff; + text-decoration: none; +} + +/* + * Dummy devices (replace them with your own or something else entirely!) + */ + +.product-device { + position: absolute; + right: 10%; + bottom: -30%; + width: 300px; + height: 540px; + background-color: #333; + border-radius: 21px; + transform: rotate(30deg); +} + +.product-device::before { + position: absolute; + top: 10%; + right: 10px; + bottom: 10%; + left: 10px; + content: ""; + background-color: rgba(255, 255, 255, .1); + border-radius: 5px; +} + +.product-device-2 { + top: -25%; + right: auto; + bottom: 0; + left: 5%; + background-color: #e5e5e5; +} + + +/* + * Extra utilities + */ + +.flex-equal > * { + flex: 1; +} +@media (min-width: 768px) { + .flex-md-equal > * { + flex: 1; + } +} diff --git a/docs/5.3/examples/sidebars/index.html b/docs/5.3/examples/sidebars/index.html new file mode 100644 index 0000000000..8424462bbf --- /dev/null +++ b/docs/5.3/examples/sidebars/index.html @@ -0,0 +1,475 @@ + + + + + + + + + Sidebars · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Bootstrap + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Sidebars examples

+ +
+ + + Sidebar + +
+ +
+
+ + +
+
+ +
+ +
+ + + Sidebar + +
+ +
+
+ + +
+
+ +
+ +
+ + + + + +
+ + +
+
+ +
+ +
+ + + Collapsible + + +
+ +
+ +
+ + + List group + +
+ +
+ List group item heading + Wed +
+
Some placeholder content in a paragraph below the heading and date.
+ + +
+ List group item heading + Tues +
+
Some placeholder content in a paragraph below the heading and date.
+ + +
+ List group item heading + Mon +
+
Some placeholder content in a paragraph below the heading and date.
+ + + +
+ List group item heading + Wed +
+
Some placeholder content in a paragraph below the heading and date.
+ + +
+ List group item heading + Tues +
+
Some placeholder content in a paragraph below the heading and date.
+ + +
+ List group item heading + Mon +
+
Some placeholder content in a paragraph below the heading and date.
+ + +
+ List group item heading + Wed +
+
Some placeholder content in a paragraph below the heading and date.
+ + +
+ List group item heading + Tues +
+
Some placeholder content in a paragraph below the heading and date.
+ + +
+ List group item heading + Mon +
+
Some placeholder content in a paragraph below the heading and date.
+ + +
+ List group item heading + Wed +
+
Some placeholder content in a paragraph below the heading and date.
+ + +
+ List group item heading + Tues +
+
Some placeholder content in a paragraph below the heading and date.
+ + +
+ List group item heading + Mon +
+
Some placeholder content in a paragraph below the heading and date.
+ +
+
+ +
+
+ + + + + + + diff --git a/docs/5.3/examples/sidebars/sidebars.css b/docs/5.3/examples/sidebars/sidebars.css new file mode 100644 index 0000000000..5dc9fbaebd --- /dev/null +++ b/docs/5.3/examples/sidebars/sidebars.css @@ -0,0 +1,59 @@ +body { + min-height: 100vh; + min-height: -webkit-fill-available; +} + +html { + height: -webkit-fill-available; +} + +main { + height: 100vh; + height: -webkit-fill-available; + max-height: 100vh; + overflow-x: auto; + overflow-y: hidden; +} + +.dropdown-toggle { outline: 0; } + +.btn-toggle { + padding: .25rem .5rem; + font-weight: 600; + color: rgba(0, 0, 0, .65); + background-color: transparent; +} +.btn-toggle:hover, +.btn-toggle:focus { + color: rgba(0, 0, 0, .85); + background-color: #d2f4ea; +} + +.btn-toggle::before { + width: 1.25em; + line-height: 0; + content: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' viewBox='0 0 16 16'%3e%3cpath fill='none' stroke='rgba%280,0,0,.5%29' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M5 14l6-6-6-6'/%3e%3c/svg%3e"); + transition: transform .35s ease; + transform-origin: .5em 50%; +} + +.btn-toggle[aria-expanded="true"] { + color: rgba(0, 0, 0, .85); +} +.btn-toggle[aria-expanded="true"]::before { + transform: rotate(90deg); +} + +.btn-toggle-nav a { + padding: .1875rem .5rem; + margin-top: .125rem; + margin-left: 1.25rem; +} +.btn-toggle-nav a:hover, +.btn-toggle-nav a:focus { + background-color: #d2f4ea; +} + +.scrollarea { + overflow-y: auto; +} diff --git a/docs/5.3/examples/sidebars/sidebars.js b/docs/5.3/examples/sidebars/sidebars.js new file mode 100644 index 0000000000..4075f1f155 --- /dev/null +++ b/docs/5.3/examples/sidebars/sidebars.js @@ -0,0 +1,8 @@ +/* global bootstrap: false */ +(() => { + 'use strict' + const tooltipTriggerList = Array.from(document.querySelectorAll('[data-bs-toggle="tooltip"]')) + tooltipTriggerList.forEach(tooltipTriggerEl => { + new bootstrap.Tooltip(tooltipTriggerEl) + }) +})() diff --git a/docs/5.3/examples/sign-in/index.html b/docs/5.3/examples/sign-in/index.html new file mode 100644 index 0000000000..e46b23ce65 --- /dev/null +++ b/docs/5.3/examples/sign-in/index.html @@ -0,0 +1,115 @@ + + + + + + + + + Signin Template · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +

Please sign in

+ +
+ + +
+
+ + +
+ +
+ +
+ +

© 2017–2022

+
+
+ + + + + diff --git a/docs/5.3/examples/sign-in/sign-in.css b/docs/5.3/examples/sign-in/sign-in.css new file mode 100644 index 0000000000..89deea44c5 --- /dev/null +++ b/docs/5.3/examples/sign-in/sign-in.css @@ -0,0 +1,33 @@ +html, +body { + height: 100%; +} + +body { + display: flex; + align-items: center; + padding-top: 40px; + padding-bottom: 40px; + background-color: #f5f5f5; +} + +.form-signin { + max-width: 330px; + padding: 15px; +} + +.form-signin .form-floating:focus-within { + z-index: 2; +} + +.form-signin input[type="email"] { + margin-bottom: -1px; + border-bottom-right-radius: 0; + border-bottom-left-radius: 0; +} + +.form-signin input[type="password"] { + margin-bottom: 10px; + border-top-left-radius: 0; + border-top-right-radius: 0; +} diff --git a/docs/5.3/examples/starter-template/index.html b/docs/5.3/examples/starter-template/index.html new file mode 100644 index 0000000000..be20c31a83 --- /dev/null +++ b/docs/5.3/examples/starter-template/index.html @@ -0,0 +1,139 @@ + + + + + + + + + Starter Template · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + Bootstrap + Starter template + +
+ +
+

Get started with Bootstrap

+

Quickly and easily get started with Bootstrap's compiled, production-ready files with this barebones example featuring some basic HTML and helpful links. Download all our examples to get started.

+ +
+ Download examples +
+ +
+ +
+
+

Starter projects

+

Ready to beyond the starter template? Check out these open source projects that you can quickly duplicate to a new GitHub repository.

+ +
+ +
+

Guides

+

Read more detailed instructions and documentation on using or contributing to Bootstrap.

+ +
+
+
+
+ Created by the Bootstrap team · © 2022 +
+
+ + + + + + + diff --git a/docs/5.3/examples/starter-template/starter-template.css b/docs/5.3/examples/starter-template/starter-template.css new file mode 100644 index 0000000000..582dcbe4f6 --- /dev/null +++ b/docs/5.3/examples/starter-template/starter-template.css @@ -0,0 +1,9 @@ +.icon-list li::before { + display: block; + flex-shrink: 0; + width: 1.5em; + height: 1.5em; + margin-right: .5rem; + content: ""; + background: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='%23212529' viewBox='0 0 16 16'%3E%3Cpath d='M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0zM4.5 7.5a.5.5 0 0 0 0 1h5.793l-2.147 2.146a.5.5 0 0 0 .708.708l3-3a.5.5 0 0 0 0-.708l-3-3a.5.5 0 1 0-.708.708L10.293 7.5H4.5z'/%3E%3C/svg%3E") no-repeat center center / 100% auto; +} diff --git a/docs/5.3/examples/sticky-footer-navbar/index.html b/docs/5.3/examples/sticky-footer-navbar/index.html new file mode 100644 index 0000000000..079fe68516 --- /dev/null +++ b/docs/5.3/examples/sticky-footer-navbar/index.html @@ -0,0 +1,137 @@ + + + + + + + + + Sticky Footer Navbar Template · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+
+

Sticky footer with fixed navbar

+

Pin a footer to the bottom of the viewport in desktop browsers with this custom HTML and CSS. A fixed navbar has been added with padding-top: 60px; on the main > .container.

+

Back to the default sticky footer minus the navbar.

+
+
+ +
+
+ Place sticky footer content here. +
+
+ + + + + + + diff --git a/docs/5.3/examples/sticky-footer-navbar/sticky-footer-navbar.css b/docs/5.3/examples/sticky-footer-navbar/sticky-footer-navbar.css new file mode 100644 index 0000000000..3087ead7db --- /dev/null +++ b/docs/5.3/examples/sticky-footer-navbar/sticky-footer-navbar.css @@ -0,0 +1,7 @@ +/* Custom page CSS +-------------------------------------------------- */ +/* Not required for template or sticky footer method. */ + +main > .container { + padding: 60px 15px 0; +} diff --git a/docs/5.3/examples/sticky-footer/index.html b/docs/5.3/examples/sticky-footer/index.html new file mode 100644 index 0000000000..79f9ed70a4 --- /dev/null +++ b/docs/5.3/examples/sticky-footer/index.html @@ -0,0 +1,106 @@ + + + + + + + + + Sticky Footer Template · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+

Sticky footer

+

Pin a footer to the bottom of the viewport in desktop browsers with this custom HTML and CSS.

+

Use the sticky footer with a fixed navbar if need be, too.

+
+
+ +
+
+ Place sticky footer content here. +
+
+ + + + + diff --git a/docs/5.3/examples/sticky-footer/sticky-footer.css b/docs/5.3/examples/sticky-footer/sticky-footer.css new file mode 100644 index 0000000000..f8be437294 --- /dev/null +++ b/docs/5.3/examples/sticky-footer/sticky-footer.css @@ -0,0 +1,9 @@ +/* Custom page CSS +-------------------------------------------------- */ +/* Not required for template or sticky footer method. */ + +.container { + width: auto; + max-width: 680px; + padding: 0 15px; +} diff --git a/docs/5.3/extend/approach/index.html b/docs/5.3/extend/approach/index.html new file mode 100644 index 0000000000..2c1d305719 --- /dev/null +++ b/docs/5.3/extend/approach/index.html @@ -0,0 +1,721 @@ + + + + + + + + + + + + +Approach · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Approach

+
+

Learn about the guiding principles, strategies, and techniques used to build and maintain Bootstrap so you can more easily customize and extend it yourself.

+ + +
+ + + +
+ + +

While the getting started pages provide an introductory tour of the project and what it offers, this document focuses on why we do the things we do in Bootstrap. It explains our philosophy to building on the web so that others can learn from us, contribute with us, and help us improve.

+

See something that doesn’t sound right, or perhaps could be done better? Open an issue—we’d love to discuss it with you.

+

Summary

+

We’ll dive into each of these more throughout, but at a high level, here’s what guides our approach.

+
    +
  • Components should be responsive and mobile-first
    • +
  • Components should be built with a base class and extended via modifier classes
    • +
  • Component states should obey a common z-index scale
    • +
  • Whenever possible, prefer a HTML and CSS implementation over JavaScript
    • +
  • Whenever possible, use utilities over custom styles
    • +
  • Whenever possible, avoid enforcing strict HTML requirements (children selectors)
    • +
+

Responsive

+

Bootstrap’s responsive styles are built to be responsive, an approach that’s often referred to as mobile-first. We use this term in our docs and largely agree with it, but at times it can be too broad. While not every component must be entirely responsive in Bootstrap, this responsive approach is about reducing CSS overrides by pushing you to add styles as the viewport becomes larger.

+

Across Bootstrap, you’ll see this most clearly in our media queries. In most cases, we use min-width queries that begin to apply at a specific breakpoint and carry up through the higher breakpoints. For example, a .d-none applies from min-width: 0 to infinity. On the other hand, a .d-md-none applies from the medium breakpoint and up.

+

At times we’ll use max-width when a component’s inherent complexity requires it. At times, these overrides are functionally and mentally clearer to implement and support than rewriting core functionality from our components. We strive to limit this approach, but will use it from time to time.

+

Classes

+

Aside from our Reboot, a cross-browser normalization stylesheet, all our styles aim to use classes as selectors. This means steering clear of type selectors (e.g., input[type="text"]) and extraneous parent classes (e.g., .parent .child) that make styles too specific to easily override.

+

As such, components should be built with a base class that houses common, not-to-be overridden property-value pairs. For example, .btn and .btn-primary. We use .btn for all the common styles like display, padding, and border-width. We then use modifiers like .btn-primary to add the color, background-color, border-color, etc.

+

Modifier classes should only be used when there are multiple properties or values to be changed across multiple variants. Modifiers are not always necessary, so be sure you’re actually saving lines of code and preventing unnecessary overrides when creating them. Good examples of modifiers are our theme color classes and size variants.

+

z-index scales

+

There are two z-index scales in Bootstrap—elements within a component and overlay components.

+

Component elements

+
    +
  • Some components in Bootstrap are built with overlapping elements to prevent double borders without modifying the border property. For example, button groups, input groups, and pagination.
    • +
  • These components share a standard z-index scale of 0 through 3.
    • +
  • 0 is default (initial), 1 is :hover, 2 is :active/.active, and 3 is :focus.
    • +
  • This approach matches our expectations of highest user priority. If an element is focused, it’s in view and at the user’s attention. Active elements are second highest because they indicate state. Hover is third highest because it indicates user intent, but nearly anything can be hovered.
    • +
+

Overlay components

+

Bootstrap includes several components that function as an overlay of some kind. This includes, in order of highest z-index, dropdowns, fixed and sticky navbars, modals, tooltips, and popovers. These components have their own z-index scale that begins at 1000. This starting number was chosen arbitrarily and serves as a small buffer between our styles and your project’s custom styles.

+

Each overlay component increases its z-index value slightly in such a way that common UI principles allow user focused or hovered elements to remain in view at all times. For example, a modal is document blocking (e.g., you cannot take any other action save for the modal’s action), so we put that above our navbars.

+

Learn more about this in our z-index layout page.

+

HTML and CSS over JS

+

Whenever possible, we prefer to write HTML and CSS over JavaScript. In general, HTML and CSS are more prolific and accessible to more people of all different experience levels. HTML and CSS are also faster in your browser than JavaScript, and your browser generally provides a great deal of functionality for you.

+

This principle is our first-class JavaScript API using data attributes. You don’t need to write nearly any JavaScript to use our JavaScript plugins; instead, write HTML. Read more about this in our JavaScript overview page.

+

Lastly, our styles build on the fundamental behaviors of common web elements. Whenever possible, we prefer to use what the browser provides. For example, you can put a .btn class on nearly any element, but most elements don’t provide any semantic value or browser functionality. So instead, we use <button>s and <a>s.

+

The same goes for more complex components. While we could write our own form validation plugin to add classes to a parent element based on an input’s state, thereby allowing us to style the text say red, we prefer using the :valid/:invalid pseudo-elements every browser provides us.

+

Utilities

+

Utility classes—formerly helpers in Bootstrap 3—are a powerful ally in combating CSS bloat and poor page performance. A utility class is typically a single, immutable property-value pairing expressed as a class (e.g., .d-block represents display: block;). Their primary appeal is speed of use while writing HTML and limiting the amount of custom CSS you have to write.

+

Specifically regarding custom CSS, utilities can help combat increasing file size by reducing your most commonly repeated property-value pairs into single classes. This can have a dramatic effect at scale in your projects.

+

Flexible HTML

+

While not always possible, we strive to avoid being overly dogmatic in our HTML requirements for components. Thus, we focus on single classes in our CSS selectors and try to avoid immediate children selectors (>). This gives you more flexibility in your implementation and helps keep our CSS simpler and less specific.

+

Code conventions

+

Code Guide (from Bootstrap co-creator, @mdo) documents how we write our HTML and CSS across Bootstrap. It specifies guidelines for general formatting, common sense defaults, property and attribute orders, and more.

+

We use Stylelint to enforce these standards and more in our Sass/CSS. Our custom Stylelint config is open source and available for others to use and extend.

+

We use vnu-jar to enforce standard and semantic HTML, as well as detecting common errors.

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/extend/icons/index.html b/docs/5.3/extend/icons/index.html new file mode 100644 index 0000000000..08de305625 --- /dev/null +++ b/docs/5.3/extend/icons/index.html @@ -0,0 +1,702 @@ + + + + + + + + + + + + +Icons · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Icons

+
+

Guidance and suggestions for using external icon libraries with Bootstrap.

+ + +
+ + + +
+ + +

While Bootstrap doesn’t include an icon set by default, we do have our own comprehensive icon library called Bootstrap Icons. Feel free to use them or any other icon set in your project. We’ve included details for Bootstrap Icons and other preferred icon sets below.

+

While most icon sets include multiple file formats, we prefer SVG implementations for their improved accessibility and vector support.

+

Bootstrap Icons

+

Bootstrap Icons is a growing library of SVG icons that are designed by @mdo and maintained by the Bootstrap Team. The beginnings of this icon set come from Bootstrap’s very own components—our forms, carousels, and more. Bootstrap has very few icon needs out of the box, so we didn’t need much. However, once we got going, we couldn’t stop making more.

+

Oh, and did we mention they’re completely open source? Licensed under MIT, just like Bootstrap, our icon set is available to everyone.

+

Learn more about Bootstrap Icons, including how to install them and recommended usage.

+

Alternatives

+

We’ve tested and used these icon sets ourselves as preferred alternatives to Bootstrap Icons.

+ + +

More options

+

While we haven’t tried these out ourselves, they do look promising and provide multiple formats, including SVG.

+ + + +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/extend/index.html b/docs/5.3/extend/index.html new file mode 100644 index 0000000000..0d0a40600b --- /dev/null +++ b/docs/5.3/extend/index.html @@ -0,0 +1,12 @@ + + + + + + https://getbootstrap.com/docs/5.3/extend/approach/ + + + + + + diff --git a/docs/5.3/forms/checks-radios/index.html b/docs/5.3/forms/checks-radios/index.html new file mode 100644 index 0000000000..43aec9caa3 --- /dev/null +++ b/docs/5.3/forms/checks-radios/index.html @@ -0,0 +1,1370 @@ + + + + + + + + + + + + +Checks and radios · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Checks and radios

+
+

Create consistent cross-browser and cross-device checkboxes and radios with our completely rewritten checks component.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Approach

+

Browser default checkboxes and radios are replaced with the help of .form-check, a series of classes for both input types that improves the layout and behavior of their HTML elements, that provide greater customization and cross browser consistency. Checkboxes are for selecting one or several options in a list, while radios are for selecting one option from many.

+

Structurally, our <input>s and <label>s are sibling elements as opposed to an <input> within a <label>. This is slightly more verbose as you must specify id and for attributes to relate the <input> and <label>. We use the sibling selector (~) for all our <input> states, like :checked or :disabled. When combined with the .form-check-label class, we can easily style the text for each item based on the <input>’s state.

+

Our checks use custom Bootstrap icons to indicate checked or indeterminate states.

+

Checks

+
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-check">
+  <input class="form-check-input" type="checkbox" value="" id="flexCheckDefault">
+  <label class="form-check-label" for="flexCheckDefault">
+    Default checkbox
+  </label>
+</div>
+<div class="form-check">
+  <input class="form-check-input" type="checkbox" value="" id="flexCheckChecked" checked>
+  <label class="form-check-label" for="flexCheckChecked">
+    Checked checkbox
+  </label>
+</div>
+ +

Indeterminate

+

Checkboxes can utilize the :indeterminate pseudo class when manually set via JavaScript (there is no available HTML attribute for specifying it).

+
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-check">
+  <input class="form-check-input" type="checkbox" value="" id="flexCheckIndeterminate">
+  <label class="form-check-label" for="flexCheckIndeterminate">
+    Indeterminate checkbox
+  </label>
+</div>
+ +

Disabled

+

Add the disabled attribute and the associated <label>s are automatically styled to match with a lighter color to help indicate the input’s state.

+
+
+ + +
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-check">
+  <input class="form-check-input" type="checkbox" value="" id="flexCheckIndeterminateDisabled" disabled>
+  <label class="form-check-label" for="flexCheckIndeterminateDisabled">
+    Disabled indeterminate checkbox
+  </label>
+</div>
+<div class="form-check">
+  <input class="form-check-input" type="checkbox" value="" id="flexCheckDisabled" disabled>
+  <label class="form-check-label" for="flexCheckDisabled">
+    Disabled checkbox
+  </label>
+</div>
+<div class="form-check">
+  <input class="form-check-input" type="checkbox" value="" id="flexCheckCheckedDisabled" checked disabled>
+  <label class="form-check-label" for="flexCheckCheckedDisabled">
+    Disabled checked checkbox
+  </label>
+</div>
+ +

Radios

+
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-check">
+  <input class="form-check-input" type="radio" name="flexRadioDefault" id="flexRadioDefault1">
+  <label class="form-check-label" for="flexRadioDefault1">
+    Default radio
+  </label>
+</div>
+<div class="form-check">
+  <input class="form-check-input" type="radio" name="flexRadioDefault" id="flexRadioDefault2" checked>
+  <label class="form-check-label" for="flexRadioDefault2">
+    Default checked radio
+  </label>
+</div>
+ +

Disabled

+

Add the disabled attribute and the associated <label>s are automatically styled to match with a lighter color to help indicate the input’s state.

+
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-check">
+  <input class="form-check-input" type="radio" name="flexRadioDisabled" id="flexRadioDisabled" disabled>
+  <label class="form-check-label" for="flexRadioDisabled">
+    Disabled radio
+  </label>
+</div>
+<div class="form-check">
+  <input class="form-check-input" type="radio" name="flexRadioDisabled" id="flexRadioCheckedDisabled" checked disabled>
+  <label class="form-check-label" for="flexRadioCheckedDisabled">
+    Disabled checked radio
+  </label>
+</div>
+ +

Switches

+

A switch has the markup of a custom checkbox but uses the .form-switch class to render a toggle switch. Consider using role="switch" to more accurately convey the nature of the control to assistive technologies that support this role. In older assistive technologies, it will simply be announced as a regular checkbox as a fallback. Switches also support the disabled attribute.

+
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-check form-switch">
+  <input class="form-check-input" type="checkbox" role="switch" id="flexSwitchCheckDefault">
+  <label class="form-check-label" for="flexSwitchCheckDefault">Default switch checkbox input</label>
+</div>
+<div class="form-check form-switch">
+  <input class="form-check-input" type="checkbox" role="switch" id="flexSwitchCheckChecked" checked>
+  <label class="form-check-label" for="flexSwitchCheckChecked">Checked switch checkbox input</label>
+</div>
+<div class="form-check form-switch">
+  <input class="form-check-input" type="checkbox" role="switch" id="flexSwitchCheckDisabled" disabled>
+  <label class="form-check-label" for="flexSwitchCheckDisabled">Disabled switch checkbox input</label>
+</div>
+<div class="form-check form-switch">
+  <input class="form-check-input" type="checkbox" role="switch" id="flexSwitchCheckCheckedDisabled" checked disabled>
+  <label class="form-check-label" for="flexSwitchCheckCheckedDisabled">Disabled checked switch checkbox input</label>
+</div>
+ +

Default (stacked)

+

By default, any number of checkboxes and radios that are immediate sibling will be vertically stacked and appropriately spaced with .form-check.

+
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-check">
+  <input class="form-check-input" type="checkbox" value="" id="defaultCheck1">
+  <label class="form-check-label" for="defaultCheck1">
+    Default checkbox
+  </label>
+</div>
+<div class="form-check">
+  <input class="form-check-input" type="checkbox" value="" id="defaultCheck2" disabled>
+  <label class="form-check-label" for="defaultCheck2">
+    Disabled checkbox
+  </label>
+</div>
+ +
+
+ + +
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-check">
+  <input class="form-check-input" type="radio" name="exampleRadios" id="exampleRadios1" value="option1" checked>
+  <label class="form-check-label" for="exampleRadios1">
+    Default radio
+  </label>
+</div>
+<div class="form-check">
+  <input class="form-check-input" type="radio" name="exampleRadios" id="exampleRadios2" value="option2">
+  <label class="form-check-label" for="exampleRadios2">
+    Second default radio
+  </label>
+</div>
+<div class="form-check">
+  <input class="form-check-input" type="radio" name="exampleRadios" id="exampleRadios3" value="option3" disabled>
+  <label class="form-check-label" for="exampleRadios3">
+    Disabled radio
+  </label>
+</div>
+ +

Inline

+

Group checkboxes or radios on the same horizontal row by adding .form-check-inline to any .form-check.

+
+
+ + +
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-check form-check-inline">
+  <input class="form-check-input" type="checkbox" id="inlineCheckbox1" value="option1">
+  <label class="form-check-label" for="inlineCheckbox1">1</label>
+</div>
+<div class="form-check form-check-inline">
+  <input class="form-check-input" type="checkbox" id="inlineCheckbox2" value="option2">
+  <label class="form-check-label" for="inlineCheckbox2">2</label>
+</div>
+<div class="form-check form-check-inline">
+  <input class="form-check-input" type="checkbox" id="inlineCheckbox3" value="option3" disabled>
+  <label class="form-check-label" for="inlineCheckbox3">3 (disabled)</label>
+</div>
+ +
+
+ + +
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-check form-check-inline">
+  <input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio1" value="option1">
+  <label class="form-check-label" for="inlineRadio1">1</label>
+</div>
+<div class="form-check form-check-inline">
+  <input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio2" value="option2">
+  <label class="form-check-label" for="inlineRadio2">2</label>
+</div>
+<div class="form-check form-check-inline">
+  <input class="form-check-input" type="radio" name="inlineRadioOptions" id="inlineRadio3" value="option3" disabled>
+  <label class="form-check-label" for="inlineRadio3">3 (disabled)</label>
+</div>
+ +

Reverse

+

Put your checkboxes, radios, and switches on the opposite side with the .form-check-reverse modifier class.

+
+
+ + +
+
+ + +
+ +
+ + +
+
+ html +
+ + +
+ 
<div class="form-check form-check-reverse">
+  <input class="form-check-input" type="checkbox" value="" id="reverseCheck1">
+  <label class="form-check-label" for="reverseCheck1">
+    Reverse checkbox
+  </label>
+</div>
+<div class="form-check form-check-reverse">
+  <input class="form-check-input" type="checkbox" value="" id="reverseCheck2" disabled>
+  <label class="form-check-label" for="reverseCheck2">
+    Disabled reverse checkbox
+  </label>
+</div>
+
+<div class="form-check form-switch form-check-reverse">
+  <input class="form-check-input" type="checkbox" id="flexSwitchCheckReverse">
+  <label class="form-check-label" for="flexSwitchCheckReverse">Reverse switch checkbox input</label>
+</div>
+ +

Without labels

+

Omit the wrapping .form-check for checkboxes and radios that have no label text. Remember to still provide some form of accessible name for assistive technologies (for instance, using aria-label). See the forms overview accessibility section for details.

+
+
+ +
+ +
+ +
+
+ html +
+ + +
+ 
<div>
+  <input class="form-check-input" type="checkbox" id="checkboxNoLabel" value="" aria-label="...">
+</div>
+
+<div>
+  <input class="form-check-input" type="radio" name="radioNoLabel" id="radioNoLabel1" value="" aria-label="...">
+</div>
+ +

Toggle buttons

+

Create button-like checkboxes and radio buttons by using .btn styles rather than .form-check-label on the <label> elements. These toggle buttons can further be grouped in a button group if needed.

+

Checkbox toggle buttons

+
+ + +
+ html +
+ + +
+ 
<input type="checkbox" class="btn-check" id="btn-check" autocomplete="off">
+<label class="btn btn-primary" for="btn-check">Single toggle</label>
+ +
+ + +
+ html +
+ + +
+ 
<input type="checkbox" class="btn-check" id="btn-check-2" checked autocomplete="off">
+<label class="btn btn-primary" for="btn-check-2">Checked</label>
+ +
+ + +
+ html +
+ + +
+ 
<input type="checkbox" class="btn-check" id="btn-check-3" autocomplete="off" disabled>
+<label class="btn btn-primary" for="btn-check-3">Disabled</label>
+ +
+Visually, these checkbox toggle buttons are identical to the button plugin toggle buttons. However, they are conveyed differently by assistive technologies: the checkbox toggles will be announced by screen readers as “checked”/“not checked” (since, despite their appearance, they are fundamentally still checkboxes), whereas the button plugin toggle buttons will be announced as “button”/“button pressed”. The choice between these two approaches will depend on the type of toggle you are creating, and whether or not the toggle will make sense to users when announced as a checkbox or as an actual button. +
+ +

Radio toggle buttons

+
+ + + + + + + + + + + +
+ html +
+ + +
+ 
<input type="radio" class="btn-check" name="options" id="option1" autocomplete="off" checked>
+<label class="btn btn-secondary" for="option1">Checked</label>
+
+<input type="radio" class="btn-check" name="options" id="option2" autocomplete="off">
+<label class="btn btn-secondary" for="option2">Radio</label>
+
+<input type="radio" class="btn-check" name="options" id="option3" autocomplete="off" disabled>
+<label class="btn btn-secondary" for="option3">Disabled</label>
+
+<input type="radio" class="btn-check" name="options" id="option4" autocomplete="off">
+<label class="btn btn-secondary" for="option4">Radio</label>
+ +

Outlined styles

+

Different variants of .btn, such at the various outlined styles, are supported.

+
+ +
+ + +
+ + + + + + +
+ html +
+ + +
+ 
<input type="checkbox" class="btn-check" id="btn-check-outlined" autocomplete="off">
+<label class="btn btn-outline-primary" for="btn-check-outlined">Single toggle</label><br>
+
+<input type="checkbox" class="btn-check" id="btn-check-2-outlined" checked autocomplete="off">
+<label class="btn btn-outline-secondary" for="btn-check-2-outlined">Checked</label><br>
+
+<input type="radio" class="btn-check" name="options-outlined" id="success-outlined" autocomplete="off" checked>
+<label class="btn btn-outline-success" for="success-outlined">Checked success radio</label>
+
+<input type="radio" class="btn-check" name="options-outlined" id="danger-outlined" autocomplete="off">
+<label class="btn btn-outline-danger" for="danger-outlined">Danger radio</label>
+ +

Sass

+

Variables

+

Variables for checks:

+
$form-check-input-width:                  1em;
+$form-check-min-height:                   $font-size-base * $line-height-base;
+$form-check-padding-start:                $form-check-input-width + .5em;
+$form-check-margin-bottom:                .125rem;
+$form-check-label-color:                  null;
+$form-check-label-cursor:                 null;
+$form-check-transition:                   null;
+
+$form-check-input-active-filter:          brightness(90%);
+
+$form-check-input-bg:                     $input-bg;
+$form-check-input-border:                 var(--#{$prefix}border-width) solid var(--#{$prefix}border-color);
+$form-check-input-border-radius:          .25em;
+$form-check-radio-border-radius:          50%;
+$form-check-input-focus-border:           $input-focus-border-color;
+$form-check-input-focus-box-shadow:       $input-btn-focus-box-shadow;
+
+$form-check-input-checked-color:          $component-active-color;
+$form-check-input-checked-bg-color:       $component-active-bg;
+$form-check-input-checked-border-color:   $form-check-input-checked-bg-color;
+$form-check-input-checked-bg-image:       url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 20 20'><path fill='none' stroke='#{$form-check-input-checked-color}' stroke-linecap='round' stroke-linejoin='round' stroke-width='3' d='m6 10 3 3 6-6'/></svg>");
+$form-check-radio-checked-bg-image:       url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='-4 -4 8 8'><circle r='2' fill='#{$form-check-input-checked-color}'/></svg>");
+
+$form-check-input-indeterminate-color:          $component-active-color;
+$form-check-input-indeterminate-bg-color:       $component-active-bg;
+$form-check-input-indeterminate-border-color:   $form-check-input-indeterminate-bg-color;
+$form-check-input-indeterminate-bg-image:       url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 20 20'><path fill='none' stroke='#{$form-check-input-indeterminate-color}' stroke-linecap='round' stroke-linejoin='round' stroke-width='3' d='M6 10h8'/></svg>");
+
+$form-check-input-disabled-opacity:        .5;
+$form-check-label-disabled-opacity:        $form-check-input-disabled-opacity;
+$form-check-btn-check-disabled-opacity:    $btn-disabled-opacity;
+
+$form-check-inline-margin-end:    1rem;
+
+

Variables for switches:

+
$form-switch-color:               rgba($black, .25);
+$form-switch-width:               2em;
+$form-switch-padding-start:       $form-switch-width + .5em;
+$form-switch-bg-image:            url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='-4 -4 8 8'><circle r='3' fill='#{$form-switch-color}'/></svg>");
+$form-switch-border-radius:       $form-switch-width;
+$form-switch-transition:          background-position .15s ease-in-out;
+
+$form-switch-focus-color:         $input-focus-border-color;
+$form-switch-focus-bg-image:      url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='-4 -4 8 8'><circle r='3' fill='#{$form-switch-focus-color}'/></svg>");
+
+$form-switch-checked-color:       $component-active-color;
+$form-switch-checked-bg-image:    url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='-4 -4 8 8'><circle r='3' fill='#{$form-switch-checked-color}'/></svg>");
+$form-switch-checked-bg-position: right center;
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/forms/checks/index.html b/docs/5.3/forms/checks/index.html new file mode 100644 index 0000000000..50c626b8e4 --- /dev/null +++ b/docs/5.3/forms/checks/index.html @@ -0,0 +1,12 @@ + + + + + + https://getbootstrap.com/docs/5.3/forms/checks-radios/ + + + + + + diff --git a/docs/5.3/forms/floating-labels/index.html b/docs/5.3/forms/floating-labels/index.html new file mode 100644 index 0000000000..d2108d0709 --- /dev/null +++ b/docs/5.3/forms/floating-labels/index.html @@ -0,0 +1,1061 @@ + + + + + + + + + + + + +Floating labels · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Floating labels

+
+

Create beautifully simple form labels that float over your input fields.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Example

+

Wrap a pair of <input class="form-control"> and <label> elements in .form-floating to enable floating labels with Bootstrap’s textual form fields. A placeholder is required on each <input> as our method of CSS-only floating labels uses the :placeholder-shown pseudo-element. Also note that the <input> must come first so we can utilize a sibling selector (e.g., ~).

+
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-floating mb-3">
+  <input type="email" class="form-control" id="floatingInput" placeholder="name@example.com">
+  <label for="floatingInput">Email address</label>
+</div>
+<div class="form-floating">
+  <input type="password" class="form-control" id="floatingPassword" placeholder="Password">
+  <label for="floatingPassword">Password</label>
+</div>
+ +

When there’s a value already defined, <label>s will automatically adjust to their floated position.

+
+
+ + +
+
+ html +
+ + +
+ 
<form class="form-floating">
+  <input type="email" class="form-control" id="floatingInputValue" placeholder="name@example.com" value="test@example.com">
+  <label for="floatingInputValue">Input with value</label>
+</form>
+ +

Form validation styles also work as expected.

+
+
+ + +
+
+ html +
+ + +
+ 
<form class="form-floating">
+  <input type="email" class="form-control is-invalid" id="floatingInputInvalid" placeholder="name@example.com" value="test@example.com">
+  <label for="floatingInputInvalid">Invalid input</label>
+</form>
+ +

Textareas

+

By default, <textarea>s with .form-control will be the same height as <input>s.

+
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-floating">
+  <textarea class="form-control" placeholder="Leave a comment here" id="floatingTextarea"></textarea>
+  <label for="floatingTextarea">Comments</label>
+</div>
+ +

To set a custom height on your <textarea>, do not use the rows attribute. Instead, set an explicit height (either inline or via custom CSS).

+
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-floating">
+  <textarea class="form-control" placeholder="Leave a comment here" id="floatingTextarea2" style="height: 100px"></textarea>
+  <label for="floatingTextarea2">Comments</label>
+</div>
+ +

Selects

+

Other than .form-control, floating labels are only available on .form-selects. They work in the same way, but unlike <input>s, they’ll always show the <label> in its floated state. Selects with size and multiple are not supported.

+
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-floating">
+  <select class="form-select" id="floatingSelect" aria-label="Floating label select example">
+    <option selected>Open this select menu</option>
+    <option value="1">One</option>
+    <option value="2">Two</option>
+    <option value="3">Three</option>
+  </select>
+  <label for="floatingSelect">Works with selects</label>
+</div>
+ +

Disabled

+

Add the disabled boolean attribute on an input, a textarea or a select to give it a grayed out appearance, remove pointer events, and prevent focusing.

+
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-floating mb-3">
+  <input type="email" class="form-control" id="floatingInputDisabled" placeholder="name@example.com" disabled>
+  <label for="floatingInputDisabled">Email address</label>
+</div>
+<div class="form-floating mb-3">
+  <textarea class="form-control" placeholder="Leave a comment here" id="floatingTextareaDisabled" disabled></textarea>
+  <label for="floatingTextareaDisabled">Comments</label>
+</div>
+<div class="form-floating mb-3">
+  <textarea class="form-control" placeholder="Leave a comment here" id="floatingTextarea2Disabled" style="height: 100px" disabled></textarea>
+  <label for="floatingTextarea2Disabled">Comments</label>
+</div>
+<div class="form-floating">
+  <select class="form-select" id="floatingSelectDisabled" aria-label="Floating label disabled select example" disabled>
+    <option selected>Open this select menu</option>
+    <option value="1">One</option>
+    <option value="2">Two</option>
+    <option value="3">Three</option>
+  </select>
+  <label for="floatingSelectDisabled">Works with selects</label>
+</div>
+ +

Readonly plaintext

+

Floating labels also support .form-control-plaintext, which can be helpful for toggling from an editable <input> to a plaintext value without affecting the page layout.

+
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="form-floating mb-3">
+  <input type="email" readonly class="form-control-plaintext" id="floatingEmptyPlaintextInput" placeholder="name@example.com">
+  <label for="floatingEmptyPlaintextInput">Empty input</label>
+</div>
+<div class="form-floating mb-3">
+  <input type="email" readonly class="form-control-plaintext" id="floatingPlaintextInput" placeholder="name@example.com" value="name@example.com">
+  <label for="floatingPlaintextInput">Input with value</label>
+</div>
+ +

Input groups

+

Floating labels also support .input-group.

+
+
+ @ +
+ + +
+
+
+ html +
+ + +
+ 
<div class="input-group mb-3">
+  <span class="input-group-text">@</span>
+  <div class="form-floating">
+    <input type="text" class="form-control" id="floatingInputGroup1" placeholder="Username">
+    <label for="floatingInputGroup1">Username</label>
+  </div>
+</div>
+ +

When using .input-group and .form-floating along with form validation, the -feedback should be placed outside of the .form-floating, but inside of the .input-group. This means that the feedback will need to be shown using javascript.

+
+
+ @ +
+ + +
+
+ Please choose a username. +
+
+
+ html +
+ + +
+ 
<div class="input-group has-validation">
+  <span class="input-group-text">@</span>
+  <div class="form-floating is-invalid">
+    <input type="text" class="form-control is-invalid" id="floatingInputGroup2" placeholder="Username" required>
+    <label for="floatingInputGroup2">Username</label>
+  </div>
+  <div class="invalid-feedback">
+    Please choose a username.
+  </div>
+</div>
+ +

Layout

+

When working with the Bootstrap grid system, be sure to place form elements within column classes.

+
+
+
+
+ + +
+
+
+
+ + +
+
+
+
+ html +
+ + +
+ 
<div class="row g-2">
+  <div class="col-md">
+    <div class="form-floating">
+      <input type="email" class="form-control" id="floatingInputGrid" placeholder="name@example.com" value="mdo@example.com">
+      <label for="floatingInputGrid">Email address</label>
+    </div>
+  </div>
+  <div class="col-md">
+    <div class="form-floating">
+      <select class="form-select" id="floatingSelectGrid">
+        <option selected>Open this select menu</option>
+        <option value="1">One</option>
+        <option value="2">Two</option>
+        <option value="3">Three</option>
+      </select>
+      <label for="floatingSelectGrid">Works with selects</label>
+    </div>
+  </div>
+</div>
+ +

Sass

+

Variables

+
$form-floating-height:                  add(3.5rem, $input-height-border);
+$form-floating-line-height:             1.25;
+$form-floating-padding-x:               $input-padding-x;
+$form-floating-padding-y:               1rem;
+$form-floating-input-padding-t:         1.625rem;
+$form-floating-input-padding-b:         .625rem;
+$form-floating-label-height:            1.875em;
+$form-floating-label-opacity:           .65;
+$form-floating-label-transform:         scale(.85) translateY(-.5rem) translateX(.15rem);
+$form-floating-label-disabled-color:    $gray-600;
+$form-floating-transition:              opacity .1s ease-in-out, transform .1s ease-in-out;
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/forms/form-control/index.html b/docs/5.3/forms/form-control/index.html new file mode 100644 index 0000000000..0210389398 --- /dev/null +++ b/docs/5.3/forms/form-control/index.html @@ -0,0 +1,1045 @@ + + + + + + + + + + + + +Form controls · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Form controls

+
+

Give textual form controls like <input>s and <textarea>s an upgrade with custom styles, sizing, focus states, and more.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Example

+

Form controls are styled with a mix of Sass and CSS variables, allowing them to adapt to color modes and support any customization method.

+
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="mb-3">
+  <label for="exampleFormControlInput1" class="form-label">Email address</label>
+  <input type="email" class="form-control" id="exampleFormControlInput1" placeholder="name@example.com">
+</div>
+<div class="mb-3">
+  <label for="exampleFormControlTextarea1" class="form-label">Example textarea</label>
+  <textarea class="form-control" id="exampleFormControlTextarea1" rows="3"></textarea>
+</div>
+ +

Sizing

+

Set heights using classes like .form-control-lg and .form-control-sm.

+
+ + + +
+ html +
+ + +
+ 
<input class="form-control form-control-lg" type="text" placeholder=".form-control-lg" aria-label=".form-control-lg example">
+<input class="form-control" type="text" placeholder="Default input" aria-label="default input example">
+<input class="form-control form-control-sm" type="text" placeholder=".form-control-sm" aria-label=".form-control-sm example">
+ +

Disabled

+

Add the disabled boolean attribute on an input to give it a grayed out appearance, remove pointer events, and prevent focusing.

+
+ + +
+ html +
+ + +
+ 
<input class="form-control" type="text" placeholder="Disabled input" aria-label="Disabled input example" disabled>
+<input class="form-control" type="text" value="Disabled readonly input" aria-label="Disabled input example" disabled readonly>
+ +

Readonly

+

Add the readonly boolean attribute on an input to prevent modification of the input’s value. readonly inputs can still be focused and selected, while disabled inputs cannot.

+
+ +
+ html +
+ + +
+ 
<input class="form-control" type="text" value="Readonly input here..." aria-label="readonly input example" readonly>
+ +

Readonly plain text

+

If you want to have <input readonly> elements in your form styled as plain text, replace .form-control with .form-control-plaintext to remove the default form field styling and preserve the correct margin and padding.

+
+
+ +
+ +
+
+
+ +
+ +
+
+
+ html +
+ + +
+ 
  <div class="mb-3 row">
+    <label for="staticEmail" class="col-sm-2 col-form-label">Email</label>
+    <div class="col-sm-10">
+      <input type="text" readonly class="form-control-plaintext" id="staticEmail" value="email@example.com">
+    </div>
+  </div>
+  <div class="mb-3 row">
+    <label for="inputPassword" class="col-sm-2 col-form-label">Password</label>
+    <div class="col-sm-10">
+      <input type="password" class="form-control" id="inputPassword">
+    </div>
+  </div>
+ +
+
+
+ + +
+
+ + +
+
+ +
+
+
+ html +
+ + +
+ 
<form class="row g-3">
+  <div class="col-auto">
+    <label for="staticEmail2" class="visually-hidden">Email</label>
+    <input type="text" readonly class="form-control-plaintext" id="staticEmail2" value="email@example.com">
+  </div>
+  <div class="col-auto">
+    <label for="inputPassword2" class="visually-hidden">Password</label>
+    <input type="password" class="form-control" id="inputPassword2" placeholder="Password">
+  </div>
+  <div class="col-auto">
+    <button type="submit" class="btn btn-primary mb-3">Confirm identity</button>
+  </div>
+</form>
+ +

File input

+
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="mb-3">
+  <label for="formFile" class="form-label">Default file input example</label>
+  <input class="form-control" type="file" id="formFile">
+</div>
+<div class="mb-3">
+  <label for="formFileMultiple" class="form-label">Multiple files input example</label>
+  <input class="form-control" type="file" id="formFileMultiple" multiple>
+</div>
+<div class="mb-3">
+  <label for="formFileDisabled" class="form-label">Disabled file input example</label>
+  <input class="form-control" type="file" id="formFileDisabled" disabled>
+</div>
+<div class="mb-3">
+  <label for="formFileSm" class="form-label">Small file input example</label>
+  <input class="form-control form-control-sm" id="formFileSm" type="file">
+</div>
+<div>
+  <label for="formFileLg" class="form-label">Large file input example</label>
+  <input class="form-control form-control-lg" id="formFileLg" type="file">
+</div>
+ +

Color

+

Set the type="color" and add .form-control-color to the <input>. We use the modifier class to set fixed heights and override some inconsistencies between browsers.

+
+ + +
+ html +
+ + +
+ 
<label for="exampleColorInput" class="form-label">Color picker</label>
+<input type="color" class="form-control form-control-color" id="exampleColorInput" value="#563d7c" title="Choose your color">
+ +

Datalists

+

Datalists allow you to create a group of <option>s that can be accessed (and autocompleted) from within an <input>. These are similar to <select> elements, but come with more menu styling limitations and differences. While most browsers and operating systems include some support for <datalist> elements, their styling is inconsistent at best.

+

Learn more about support for datalist elements.

+
+ + + + +
+ html +
+ + +
+ 
<label for="exampleDataList" class="form-label">Datalist example</label>
+<input class="form-control" list="datalistOptions" id="exampleDataList" placeholder="Type to search...">
+<datalist id="datalistOptions">
+  <option value="San Francisco">
+  <option value="New York">
+  <option value="Seattle">
+  <option value="Los Angeles">
+  <option value="Chicago">
+</datalist>
+ +

CSS

+

Variables

+

Form controls make use of a small amount of CSS variables to support custom styling across color modes.

+
  --#{$prefix}form-control-bg: var(--#{$prefix}body-bg);
+  --#{$prefix}form-control-disabled-bg: var(--#{$prefix}secondary-bg);
+
+

Sass variables

+

$input-* are shared across most of our form controls (and not buttons).

+
$input-padding-y:                       $input-btn-padding-y;
+$input-padding-x:                       $input-btn-padding-x;
+$input-font-family:                     $input-btn-font-family;
+$input-font-size:                       $input-btn-font-size;
+$input-font-weight:                     $font-weight-base;
+$input-line-height:                     $input-btn-line-height;
+
+$input-padding-y-sm:                    $input-btn-padding-y-sm;
+$input-padding-x-sm:                    $input-btn-padding-x-sm;
+$input-font-size-sm:                    $input-btn-font-size-sm;
+
+$input-padding-y-lg:                    $input-btn-padding-y-lg;
+$input-padding-x-lg:                    $input-btn-padding-x-lg;
+$input-font-size-lg:                    $input-btn-font-size-lg;
+
+$input-bg:                              var(--#{$prefix}form-control-bg);
+$input-disabled-color:                  null;
+$input-disabled-bg:                     var(--#{$prefix}form-control-disabled-bg);
+$input-disabled-border-color:           null;
+
+$input-color:                           var(--#{$prefix}body-color);
+$input-border-color:                    var(--#{$prefix}border-color); //$gray-400
+$input-border-width:                    $input-btn-border-width;
+$input-box-shadow:                      $box-shadow-inset;
+
+$input-border-radius:                   $border-radius;
+$input-border-radius-sm:                $border-radius-sm;
+$input-border-radius-lg:                $border-radius-lg;
+
+$input-focus-bg:                        $input-bg;
+$input-focus-border-color:              tint-color($component-active-bg, 50%);
+$input-focus-color:                     $input-color;
+$input-focus-width:                     $input-btn-focus-width;
+$input-focus-box-shadow:                $input-btn-focus-box-shadow;
+
+$input-placeholder-color:               var(--#{$prefix}secondary-color);
+$input-plaintext-color:                 var(--#{$prefix}body-color);
+
+$input-height-border:                   calc($input-border-width * 2); // stylelint-disable-line function-disallowed-list
+
+$input-height-inner:                    add($input-line-height * 1em, $input-padding-y * 2);
+$input-height-inner-half:               add($input-line-height * .5em, $input-padding-y);
+$input-height-inner-quarter:            add($input-line-height * .25em, $input-padding-y * .5);
+
+$input-height:                          add($input-line-height * 1em, add($input-padding-y * 2, $input-height-border, false));
+$input-height-sm:                       add($input-line-height * 1em, add($input-padding-y-sm * 2, $input-height-border, false));
+$input-height-lg:                       add($input-line-height * 1em, add($input-padding-y-lg * 2, $input-height-border, false));
+
+$input-transition:                      border-color .15s ease-in-out, box-shadow .15s ease-in-out;
+
+$form-color-width:                      3rem;
+
+

$form-label-* and $form-text-* are for our <label>s and .form-text component.

+
$form-label-margin-bottom:              .5rem;
+$form-label-font-size:                  null;
+$form-label-font-style:                 null;
+$form-label-font-weight:                null;
+$form-label-color:                      null;
+
+
$form-text-margin-top:                  .25rem;
+$form-text-font-size:                   $small-font-size;
+$form-text-font-style:                  null;
+$form-text-font-weight:                 null;
+$form-text-color:                       $text-muted;
+
+

$form-file-* are for file input.

+
$form-file-button-color:          $input-color;
+$form-file-button-bg:             var(--#{$prefix}tertiary-bg);
+$form-file-button-hover-bg:       var(--#{$prefix}secondary-bg);
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/forms/index.html b/docs/5.3/forms/index.html new file mode 100644 index 0000000000..a2578c00d8 --- /dev/null +++ b/docs/5.3/forms/index.html @@ -0,0 +1,12 @@ + + + + + + https://getbootstrap.com/docs/5.3/forms/overview/ + + + + + + diff --git a/docs/5.3/forms/input-group/index.html b/docs/5.3/forms/input-group/index.html new file mode 100644 index 0000000000..167a9c0175 --- /dev/null +++ b/docs/5.3/forms/input-group/index.html @@ -0,0 +1,1336 @@ + + + + + + + + + + + + +Input group · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Input group

+
+

Easily extend form controls by adding text, buttons, or button groups on either side of textual inputs, custom selects, and custom file inputs.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Basic example

+

Place one add-on or button on either side of an input. You may also place one on both sides of an input. Remember to place <label>s outside the input group.

+
+
+ @ + +
+ +
+ + @example.com +
+ +
+ +
+ https://example.com/users/ + +
+
Example help text goes outside the input group.
+
+ +
+ $ + + .00 +
+ +
+ + @ + +
+ +
+ With textarea + +
+
+ html +
+ + +
+ 
<div class="input-group mb-3">
+  <span class="input-group-text" id="basic-addon1">@</span>
+  <input type="text" class="form-control" placeholder="Username" aria-label="Username" aria-describedby="basic-addon1">
+</div>
+
+<div class="input-group mb-3">
+  <input type="text" class="form-control" placeholder="Recipient's username" aria-label="Recipient's username" aria-describedby="basic-addon2">
+  <span class="input-group-text" id="basic-addon2">@example.com</span>
+</div>
+
+<div class="mb-3">
+  <label for="basic-url" class="form-label">Your vanity URL</label>
+  <div class="input-group">
+    <span class="input-group-text" id="basic-addon3">https://example.com/users/</span>
+    <input type="text" class="form-control" id="basic-url" aria-describedby="basic-addon3">
+  </div>
+  <div class="form-text">Example help text goes outside the input group.</div>
+</div>
+
+<div class="input-group mb-3">
+  <span class="input-group-text">$</span>
+  <input type="text" class="form-control" aria-label="Amount (to the nearest dollar)">
+  <span class="input-group-text">.00</span>
+</div>
+
+<div class="input-group mb-3">
+  <input type="text" class="form-control" placeholder="Username" aria-label="Username">
+  <span class="input-group-text">@</span>
+  <input type="text" class="form-control" placeholder="Server" aria-label="Server">
+</div>
+
+<div class="input-group">
+  <span class="input-group-text">With textarea</span>
+  <textarea class="form-control" aria-label="With textarea"></textarea>
+</div>
+ +

Wrapping

+

Input groups wrap by default via flex-wrap: wrap in order to accommodate custom form field validation within an input group. You may disable this with .flex-nowrap.

+
+
+ @ + +
+
+ html +
+ + +
+ 
<div class="input-group flex-nowrap">
+  <span class="input-group-text" id="addon-wrapping">@</span>
+  <input type="text" class="form-control" placeholder="Username" aria-label="Username" aria-describedby="addon-wrapping">
+</div>
+ +

Sizing

+

Add the relative form sizing classes to the .input-group itself and contents within will automatically resize—no need for repeating the form control size classes on each element.

+

Sizing on the individual input group elements isn’t supported.

+
+
+ Small + +
+ +
+ Default + +
+ +
+ Large + +
+
+ html +
+ + +
+ 
<div class="input-group input-group-sm mb-3">
+  <span class="input-group-text" id="inputGroup-sizing-sm">Small</span>
+  <input type="text" class="form-control" aria-label="Sizing example input" aria-describedby="inputGroup-sizing-sm">
+</div>
+
+<div class="input-group mb-3">
+  <span class="input-group-text" id="inputGroup-sizing-default">Default</span>
+  <input type="text" class="form-control" aria-label="Sizing example input" aria-describedby="inputGroup-sizing-default">
+</div>
+
+<div class="input-group input-group-lg">
+  <span class="input-group-text" id="inputGroup-sizing-lg">Large</span>
+  <input type="text" class="form-control" aria-label="Sizing example input" aria-describedby="inputGroup-sizing-lg">
+</div>
+ +

Checkboxes and radios

+

Place any checkbox or radio option within an input group’s addon instead of text. We recommend adding .mt-0 to the .form-check-input when there’s no visible text next to the input.

+
+
+
+ +
+ +
+ +
+
+ +
+ +
+
+ html +
+ + +
+ 
<div class="input-group mb-3">
+  <div class="input-group-text">
+    <input class="form-check-input mt-0" type="checkbox" value="" aria-label="Checkbox for following text input">
+  </div>
+  <input type="text" class="form-control" aria-label="Text input with checkbox">
+</div>
+
+<div class="input-group">
+  <div class="input-group-text">
+    <input class="form-check-input mt-0" type="radio" value="" aria-label="Radio button for following text input">
+  </div>
+  <input type="text" class="form-control" aria-label="Text input with radio button">
+</div>
+ +

Multiple inputs

+

While multiple <input>s are supported visually, validation styles are only available for input groups with a single <input>.

+
+
+ First and last name + + +
+
+ html +
+ + +
+ 
<div class="input-group">
+  <span class="input-group-text">First and last name</span>
+  <input type="text" aria-label="First name" class="form-control">
+  <input type="text" aria-label="Last name" class="form-control">
+</div>
+ +

Multiple addons

+

Multiple add-ons are supported and can be mixed with checkbox and radio input versions.

+
+
+ $ + 0.00 + +
+ +
+ + $ + 0.00 +
+
+ html +
+ + +
+ 
<div class="input-group mb-3">
+  <span class="input-group-text">$</span>
+  <span class="input-group-text">0.00</span>
+  <input type="text" class="form-control" aria-label="Dollar amount (with dot and two decimal places)">
+</div>
+
+<div class="input-group">
+  <input type="text" class="form-control" aria-label="Dollar amount (with dot and two decimal places)">
+  <span class="input-group-text">$</span>
+  <span class="input-group-text">0.00</span>
+</div>
+ +

Button addons

+
+
+ + +
+ +
+ + +
+ +
+ + + +
+ +
+ + + +
+
+ html +
+ + +
+ 
<div class="input-group mb-3">
+  <button class="btn btn-outline-secondary" type="button" id="button-addon1">Button</button>
+  <input type="text" class="form-control" placeholder="" aria-label="Example text with button addon" aria-describedby="button-addon1">
+</div>
+
+<div class="input-group mb-3">
+  <input type="text" class="form-control" placeholder="Recipient's username" aria-label="Recipient's username" aria-describedby="button-addon2">
+  <button class="btn btn-outline-secondary" type="button" id="button-addon2">Button</button>
+</div>
+
+<div class="input-group mb-3">
+  <button class="btn btn-outline-secondary" type="button">Button</button>
+  <button class="btn btn-outline-secondary" type="button">Button</button>
+  <input type="text" class="form-control" placeholder="" aria-label="Example text with two button addons">
+</div>
+
+<div class="input-group">
+  <input type="text" class="form-control" placeholder="Recipient's username" aria-label="Recipient's username with two button addons">
+  <button class="btn btn-outline-secondary" type="button">Button</button>
+  <button class="btn btn-outline-secondary" type="button">Button</button>
+</div>
+ +

Buttons with dropdowns

+
+
+ + + +
+ +
+ + + +
+ +
+ + + + + +
+
+ html +
+ + +
+ 
<div class="input-group mb-3">
+  <button class="btn btn-outline-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">Dropdown</button>
+  <ul class="dropdown-menu">
+    <li><a class="dropdown-item" href="#">Action</a></li>
+    <li><a class="dropdown-item" href="#">Another action</a></li>
+    <li><a class="dropdown-item" href="#">Something else here</a></li>
+    <li><hr class="dropdown-divider"></li>
+    <li><a class="dropdown-item" href="#">Separated link</a></li>
+  </ul>
+  <input type="text" class="form-control" aria-label="Text input with dropdown button">
+</div>
+
+<div class="input-group mb-3">
+  <input type="text" class="form-control" aria-label="Text input with dropdown button">
+  <button class="btn btn-outline-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">Dropdown</button>
+  <ul class="dropdown-menu dropdown-menu-end">
+    <li><a class="dropdown-item" href="#">Action</a></li>
+    <li><a class="dropdown-item" href="#">Another action</a></li>
+    <li><a class="dropdown-item" href="#">Something else here</a></li>
+    <li><hr class="dropdown-divider"></li>
+    <li><a class="dropdown-item" href="#">Separated link</a></li>
+  </ul>
+</div>
+
+<div class="input-group">
+  <button class="btn btn-outline-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">Dropdown</button>
+  <ul class="dropdown-menu">
+    <li><a class="dropdown-item" href="#">Action before</a></li>
+    <li><a class="dropdown-item" href="#">Another action before</a></li>
+    <li><a class="dropdown-item" href="#">Something else here</a></li>
+    <li><hr class="dropdown-divider"></li>
+    <li><a class="dropdown-item" href="#">Separated link</a></li>
+  </ul>
+  <input type="text" class="form-control" aria-label="Text input with 2 dropdown buttons">
+  <button class="btn btn-outline-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">Dropdown</button>
+  <ul class="dropdown-menu dropdown-menu-end">
+    <li><a class="dropdown-item" href="#">Action</a></li>
+    <li><a class="dropdown-item" href="#">Another action</a></li>
+    <li><a class="dropdown-item" href="#">Something else here</a></li>
+    <li><hr class="dropdown-divider"></li>
+    <li><a class="dropdown-item" href="#">Separated link</a></li>
+  </ul>
+</div>
+ +

Segmented buttons

+
+
+ + + + +
+ +
+ + + + +
+
+ html +
+ + +
+ 
<div class="input-group mb-3">
+  <button type="button" class="btn btn-outline-secondary">Action</button>
+  <button type="button" class="btn btn-outline-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
+    <span class="visually-hidden">Toggle Dropdown</span>
+  </button>
+  <ul class="dropdown-menu">
+    <li><a class="dropdown-item" href="#">Action</a></li>
+    <li><a class="dropdown-item" href="#">Another action</a></li>
+    <li><a class="dropdown-item" href="#">Something else here</a></li>
+    <li><hr class="dropdown-divider"></li>
+    <li><a class="dropdown-item" href="#">Separated link</a></li>
+  </ul>
+  <input type="text" class="form-control" aria-label="Text input with segmented dropdown button">
+</div>
+
+<div class="input-group">
+  <input type="text" class="form-control" aria-label="Text input with segmented dropdown button">
+  <button type="button" class="btn btn-outline-secondary">Action</button>
+  <button type="button" class="btn btn-outline-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
+    <span class="visually-hidden">Toggle Dropdown</span>
+  </button>
+  <ul class="dropdown-menu dropdown-menu-end">
+    <li><a class="dropdown-item" href="#">Action</a></li>
+    <li><a class="dropdown-item" href="#">Another action</a></li>
+    <li><a class="dropdown-item" href="#">Something else here</a></li>
+    <li><hr class="dropdown-divider"></li>
+    <li><a class="dropdown-item" href="#">Separated link</a></li>
+  </ul>
+</div>
+ +

Custom forms

+

Input groups include support for custom selects and custom file inputs. Browser default versions of these are not supported.

+

Custom select

+
+
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+
+ html +
+ + +
+ 
<div class="input-group mb-3">
+  <label class="input-group-text" for="inputGroupSelect01">Options</label>
+  <select class="form-select" id="inputGroupSelect01">
+    <option selected>Choose...</option>
+    <option value="1">One</option>
+    <option value="2">Two</option>
+    <option value="3">Three</option>
+  </select>
+</div>
+
+<div class="input-group mb-3">
+  <select class="form-select" id="inputGroupSelect02">
+    <option selected>Choose...</option>
+    <option value="1">One</option>
+    <option value="2">Two</option>
+    <option value="3">Three</option>
+  </select>
+  <label class="input-group-text" for="inputGroupSelect02">Options</label>
+</div>
+
+<div class="input-group mb-3">
+  <button class="btn btn-outline-secondary" type="button">Button</button>
+  <select class="form-select" id="inputGroupSelect03" aria-label="Example select with button addon">
+    <option selected>Choose...</option>
+    <option value="1">One</option>
+    <option value="2">Two</option>
+    <option value="3">Three</option>
+  </select>
+</div>
+
+<div class="input-group">
+  <select class="form-select" id="inputGroupSelect04" aria-label="Example select with button addon">
+    <option selected>Choose...</option>
+    <option value="1">One</option>
+    <option value="2">Two</option>
+    <option value="3">Three</option>
+  </select>
+  <button class="btn btn-outline-secondary" type="button">Button</button>
+</div>
+ +

Custom file input

+
+
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+
+ html +
+ + +
+ 
<div class="input-group mb-3">
+  <label class="input-group-text" for="inputGroupFile01">Upload</label>
+  <input type="file" class="form-control" id="inputGroupFile01">
+</div>
+
+<div class="input-group mb-3">
+  <input type="file" class="form-control" id="inputGroupFile02">
+  <label class="input-group-text" for="inputGroupFile02">Upload</label>
+</div>
+
+<div class="input-group mb-3">
+  <button class="btn btn-outline-secondary" type="button" id="inputGroupFileAddon03">Button</button>
+  <input type="file" class="form-control" id="inputGroupFile03" aria-describedby="inputGroupFileAddon03" aria-label="Upload">
+</div>
+
+<div class="input-group">
+  <input type="file" class="form-control" id="inputGroupFile04" aria-describedby="inputGroupFileAddon04" aria-label="Upload">
+  <button class="btn btn-outline-secondary" type="button" id="inputGroupFileAddon04">Button</button>
+</div>
+ +

Sass

+

Variables

+
$input-group-addon-padding-y:           $input-padding-y;
+$input-group-addon-padding-x:           $input-padding-x;
+$input-group-addon-font-weight:         $input-font-weight;
+$input-group-addon-color:               $input-color;
+$input-group-addon-bg:                  var(--#{$prefix}tertiary-bg);
+$input-group-addon-border-color:        $input-border-color;
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/forms/layout/index.html b/docs/5.3/forms/layout/index.html new file mode 100644 index 0000000000..ff03a55e33 --- /dev/null +++ b/docs/5.3/forms/layout/index.html @@ -0,0 +1,1334 @@ + + + + + + + + + + + + +Layout · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Layout

+
+

Give your forms some structure—from inline to horizontal to custom grid implementations—with our form layout options.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Forms

+

Every group of form fields should reside in a <form> element. Bootstrap provides no default styling for the <form> element, but there are some powerful browser features that are provided by default.

+
    +
  • New to browser forms? Consider reviewing the MDN form docs for an overview and complete list of available attributes.
    • +
  • <button>s within a <form> default to type="submit", so strive to be specific and always include a type.
    • +
+

Since Bootstrap applies display: block and width: 100% to almost all our form controls, forms will by default stack vertically. Additional classes can be used to vary this layout on a per-form basis.

+

Utilities

+

Margin utilities are the easiest way to add some structure to forms. They provide basic grouping of labels, controls, optional form text, and form validation messaging. We recommend sticking to margin-bottom utilities, and using a single direction throughout the form for consistency.

+

Feel free to build your forms however you like, with <fieldset>s, <div>s, or nearly any other element.

+
+
+ + +
+
+ + +
+
+ html +
+ + +
+ 
<div class="mb-3">
+  <label for="formGroupExampleInput" class="form-label">Example label</label>
+  <input type="text" class="form-control" id="formGroupExampleInput" placeholder="Example input placeholder">
+</div>
+<div class="mb-3">
+  <label for="formGroupExampleInput2" class="form-label">Another label</label>
+  <input type="text" class="form-control" id="formGroupExampleInput2" placeholder="Another input placeholder">
+</div>
+ +

Form grid

+

More complex forms can be built using our grid classes. Use these for form layouts that require multiple columns, varied widths, and additional alignment options. Requires the $enable-grid-classes Sass variable to be enabled (on by default).

+
+
+
+ +
+
+ +
+
+
+ html +
+ + +
+ 
<div class="row">
+  <div class="col">
+    <input type="text" class="form-control" placeholder="First name" aria-label="First name">
+  </div>
+  <div class="col">
+    <input type="text" class="form-control" placeholder="Last name" aria-label="Last name">
+  </div>
+</div>
+ +

Gutters

+

By adding gutter modifier classes, you can have control over the gutter width in as well the inline as block direction. Also requires the $enable-grid-classes Sass variable to be enabled (on by default).

+
+
+
+ +
+
+ +
+
+
+ html +
+ + +
+ 
<div class="row g-3">
+  <div class="col">
+    <input type="text" class="form-control" placeholder="First name" aria-label="First name">
+  </div>
+  <div class="col">
+    <input type="text" class="form-control" placeholder="Last name" aria-label="Last name">
+  </div>
+</div>
+ +

More complex layouts can also be created with the grid system.

+
+
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+
+ + +
+
+
+ +
+
+
+ html +
+ + +
+ 
<form class="row g-3">
+  <div class="col-md-6">
+    <label for="inputEmail4" class="form-label">Email</label>
+    <input type="email" class="form-control" id="inputEmail4">
+  </div>
+  <div class="col-md-6">
+    <label for="inputPassword4" class="form-label">Password</label>
+    <input type="password" class="form-control" id="inputPassword4">
+  </div>
+  <div class="col-12">
+    <label for="inputAddress" class="form-label">Address</label>
+    <input type="text" class="form-control" id="inputAddress" placeholder="1234 Main St">
+  </div>
+  <div class="col-12">
+    <label for="inputAddress2" class="form-label">Address 2</label>
+    <input type="text" class="form-control" id="inputAddress2" placeholder="Apartment, studio, or floor">
+  </div>
+  <div class="col-md-6">
+    <label for="inputCity" class="form-label">City</label>
+    <input type="text" class="form-control" id="inputCity">
+  </div>
+  <div class="col-md-4">
+    <label for="inputState" class="form-label">State</label>
+    <select id="inputState" class="form-select">
+      <option selected>Choose...</option>
+      <option>...</option>
+    </select>
+  </div>
+  <div class="col-md-2">
+    <label for="inputZip" class="form-label">Zip</label>
+    <input type="text" class="form-control" id="inputZip">
+  </div>
+  <div class="col-12">
+    <div class="form-check">
+      <input class="form-check-input" type="checkbox" id="gridCheck">
+      <label class="form-check-label" for="gridCheck">
+        Check me out
+      </label>
+    </div>
+  </div>
+  <div class="col-12">
+    <button type="submit" class="btn btn-primary">Sign in</button>
+  </div>
+</form>
+ +

Horizontal form

+

Create horizontal forms with the grid by adding the .row class to form groups and using the .col-*-* classes to specify the width of your labels and controls. Be sure to add .col-form-label to your <label>s as well so they’re vertically centered with their associated form controls.

+

At times, you maybe need to use margin or padding utilities to create that perfect alignment you need. For example, we’ve removed the padding-top on our stacked radio inputs label to better align the text baseline.

+
+
+
+ +
+ +
+
+
+ +
+ +
+
+
+ Radios +
+
+ + +
+
+ + +
+
+ + +
+
+
+
+
+
+ + +
+
+
+ +
+
+ html +
+ + +
+ 
<form>
+  <div class="row mb-3">
+    <label for="inputEmail3" class="col-sm-2 col-form-label">Email</label>
+    <div class="col-sm-10">
+      <input type="email" class="form-control" id="inputEmail3">
+    </div>
+  </div>
+  <div class="row mb-3">
+    <label for="inputPassword3" class="col-sm-2 col-form-label">Password</label>
+    <div class="col-sm-10">
+      <input type="password" class="form-control" id="inputPassword3">
+    </div>
+  </div>
+  <fieldset class="row mb-3">
+    <legend class="col-form-label col-sm-2 pt-0">Radios</legend>
+    <div class="col-sm-10">
+      <div class="form-check">
+        <input class="form-check-input" type="radio" name="gridRadios" id="gridRadios1" value="option1" checked>
+        <label class="form-check-label" for="gridRadios1">
+          First radio
+        </label>
+      </div>
+      <div class="form-check">
+        <input class="form-check-input" type="radio" name="gridRadios" id="gridRadios2" value="option2">
+        <label class="form-check-label" for="gridRadios2">
+          Second radio
+        </label>
+      </div>
+      <div class="form-check disabled">
+        <input class="form-check-input" type="radio" name="gridRadios" id="gridRadios3" value="option3" disabled>
+        <label class="form-check-label" for="gridRadios3">
+          Third disabled radio
+        </label>
+      </div>
+    </div>
+  </fieldset>
+  <div class="row mb-3">
+    <div class="col-sm-10 offset-sm-2">
+      <div class="form-check">
+        <input class="form-check-input" type="checkbox" id="gridCheck1">
+        <label class="form-check-label" for="gridCheck1">
+          Example checkbox
+        </label>
+      </div>
+    </div>
+  </div>
+  <button type="submit" class="btn btn-primary">Sign in</button>
+</form>
+ +

Horizontal form label sizing

+

Be sure to use .col-form-label-sm or .col-form-label-lg to your <label>s or <legend>s to correctly follow the size of .form-control-lg and .form-control-sm.

+
+
+ +
+ +
+
+
+ +
+ +
+
+
+ +
+ +
+
+
+ html +
+ + +
+ 
<div class="row mb-3">
+  <label for="colFormLabelSm" class="col-sm-2 col-form-label col-form-label-sm">Email</label>
+  <div class="col-sm-10">
+    <input type="email" class="form-control form-control-sm" id="colFormLabelSm" placeholder="col-form-label-sm">
+  </div>
+</div>
+<div class="row mb-3">
+  <label for="colFormLabel" class="col-sm-2 col-form-label">Email</label>
+  <div class="col-sm-10">
+    <input type="email" class="form-control" id="colFormLabel" placeholder="col-form-label">
+  </div>
+</div>
+<div class="row">
+  <label for="colFormLabelLg" class="col-sm-2 col-form-label col-form-label-lg">Email</label>
+  <div class="col-sm-10">
+    <input type="email" class="form-control form-control-lg" id="colFormLabelLg" placeholder="col-form-label-lg">
+  </div>
+</div>
+ +

Column sizing

+

As shown in the previous examples, our grid system allows you to place any number of .cols within a .row. They’ll split the available width equally between them. You may also pick a subset of your columns to take up more or less space, while the remaining .cols equally split the rest, with specific column classes like .col-sm-7.

+
+
+
+ +
+
+ +
+
+ +
+
+
+ html +
+ + +
+ 
<div class="row g-3">
+  <div class="col-sm-7">
+    <input type="text" class="form-control" placeholder="City" aria-label="City">
+  </div>
+  <div class="col-sm">
+    <input type="text" class="form-control" placeholder="State" aria-label="State">
+  </div>
+  <div class="col-sm">
+    <input type="text" class="form-control" placeholder="Zip" aria-label="Zip">
+  </div>
+</div>
+ +

Auto-sizing

+

The example below uses a flexbox utility to vertically center the contents and changes .col to .col-auto so that your columns only take up as much space as needed. Put another way, the column sizes itself based on the contents.

+
+
+
+ + +
+
+ +
+
@
+ +
+
+
+ + +
+
+
+ + +
+
+
+ +
+
+
+ html +
+ + +
+ 
<form class="row gy-2 gx-3 align-items-center">
+  <div class="col-auto">
+    <label class="visually-hidden" for="autoSizingInput">Name</label>
+    <input type="text" class="form-control" id="autoSizingInput" placeholder="Jane Doe">
+  </div>
+  <div class="col-auto">
+    <label class="visually-hidden" for="autoSizingInputGroup">Username</label>
+    <div class="input-group">
+      <div class="input-group-text">@</div>
+      <input type="text" class="form-control" id="autoSizingInputGroup" placeholder="Username">
+    </div>
+  </div>
+  <div class="col-auto">
+    <label class="visually-hidden" for="autoSizingSelect">Preference</label>
+    <select class="form-select" id="autoSizingSelect">
+      <option selected>Choose...</option>
+      <option value="1">One</option>
+      <option value="2">Two</option>
+      <option value="3">Three</option>
+    </select>
+  </div>
+  <div class="col-auto">
+    <div class="form-check">
+      <input class="form-check-input" type="checkbox" id="autoSizingCheck">
+      <label class="form-check-label" for="autoSizingCheck">
+        Remember me
+      </label>
+    </div>
+  </div>
+  <div class="col-auto">
+    <button type="submit" class="btn btn-primary">Submit</button>
+  </div>
+</form>
+ +

You can then remix that once again with size-specific column classes.

+
+
+
+ + +
+
+ +
+
@
+ +
+
+
+ + +
+
+
+ + +
+
+
+ +
+
+
+ html +
+ + +
+ 
<form class="row gx-3 gy-2 align-items-center">
+  <div class="col-sm-3">
+    <label class="visually-hidden" for="specificSizeInputName">Name</label>
+    <input type="text" class="form-control" id="specificSizeInputName" placeholder="Jane Doe">
+  </div>
+  <div class="col-sm-3">
+    <label class="visually-hidden" for="specificSizeInputGroupUsername">Username</label>
+    <div class="input-group">
+      <div class="input-group-text">@</div>
+      <input type="text" class="form-control" id="specificSizeInputGroupUsername" placeholder="Username">
+    </div>
+  </div>
+  <div class="col-sm-3">
+    <label class="visually-hidden" for="specificSizeSelect">Preference</label>
+    <select class="form-select" id="specificSizeSelect">
+      <option selected>Choose...</option>
+      <option value="1">One</option>
+      <option value="2">Two</option>
+      <option value="3">Three</option>
+    </select>
+  </div>
+  <div class="col-auto">
+    <div class="form-check">
+      <input class="form-check-input" type="checkbox" id="autoSizingCheck2">
+      <label class="form-check-label" for="autoSizingCheck2">
+        Remember me
+      </label>
+    </div>
+  </div>
+  <div class="col-auto">
+    <button type="submit" class="btn btn-primary">Submit</button>
+  </div>
+</form>
+ +

Inline forms

+

Use the .row-cols-* classes to create responsive horizontal layouts. By adding gutter modifier classes, we’ll have gutters in horizontal and vertical directions. On narrow mobile viewports, the .col-12 helps stack the form controls and more. The .align-items-center aligns the form elements to the middle, making the .form-check align properly.

+
+
+
+ +
+
@
+ +
+
+ +
+ + +
+ +
+
+ + +
+
+ +
+ +
+
+
+ html +
+ + +
+ 
<form class="row row-cols-lg-auto g-3 align-items-center">
+  <div class="col-12">
+    <label class="visually-hidden" for="inlineFormInputGroupUsername">Username</label>
+    <div class="input-group">
+      <div class="input-group-text">@</div>
+      <input type="text" class="form-control" id="inlineFormInputGroupUsername" placeholder="Username">
+    </div>
+  </div>
+
+  <div class="col-12">
+    <label class="visually-hidden" for="inlineFormSelectPref">Preference</label>
+    <select class="form-select" id="inlineFormSelectPref">
+      <option selected>Choose...</option>
+      <option value="1">One</option>
+      <option value="2">Two</option>
+      <option value="3">Three</option>
+    </select>
+  </div>
+
+  <div class="col-12">
+    <div class="form-check">
+      <input class="form-check-input" type="checkbox" id="inlineFormCheck">
+      <label class="form-check-label" for="inlineFormCheck">
+        Remember me
+      </label>
+    </div>
+  </div>
+
+  <div class="col-12">
+    <button type="submit" class="btn btn-primary">Submit</button>
+  </div>
+</form>
+ + +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/forms/overview/index.html b/docs/5.3/forms/overview/index.html new file mode 100644 index 0000000000..71e619d8f9 --- /dev/null +++ b/docs/5.3/forms/overview/index.html @@ -0,0 +1,977 @@ + + + + + + + + + + + + +Forms · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Forms

+
+

Examples and usage guidelines for form control styles, layout options, and custom components for creating a wide variety of forms.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ +
+ +
+ + Form control + Style textual inputs and textareas with support for multiple states. + +
+ +
+ + Select + Improve browser default select elements with a custom initial appearance. + +
+ +
+ + Checks & radios + Use our custom radio buttons and checkboxes in forms for selecting input options. + +
+ +
+ + Range + Replace browser default range inputs with our custom version. + +
+ +
+ + Input group + Attach labels and buttons to your inputs for increased semantic value. + +
+ +
+ + Floating labels + Create beautifully simple form labels that float over your input fields. + +
+ +
+ + Layout + Create inline, horizontal, or complex grid-based layouts with your forms. + +
+ +
+ + Validation + Validate your forms with custom or native validation behaviors and styles. + +
+ +
+ + +

Overview

+

Bootstrap’s form controls expand on our Rebooted form styles with classes. Use these classes to opt into their customized displays for a more consistent rendering across browsers and devices.

+

Be sure to use an appropriate type attribute on all inputs (e.g., email for email address or number for numerical information) to take advantage of newer input controls like email verification, number selection, and more.

+

Here’s a quick example to demonstrate Bootstrap’s form styles. Keep reading for documentation on required classes, form layout, and more.

+
+
+
+ + +
We'll never share your email with anyone else.
+
+
+ + +
+
+ + +
+ +
+
+ html +
+ + +
+ 
<form>
+  <div class="mb-3">
+    <label for="exampleInputEmail1" class="form-label">Email address</label>
+    <input type="email" class="form-control" id="exampleInputEmail1" aria-describedby="emailHelp">
+    <div id="emailHelp" class="form-text">We'll never share your email with anyone else.</div>
+  </div>
+  <div class="mb-3">
+    <label for="exampleInputPassword1" class="form-label">Password</label>
+    <input type="password" class="form-control" id="exampleInputPassword1">
+  </div>
+  <div class="mb-3 form-check">
+    <input type="checkbox" class="form-check-input" id="exampleCheck1">
+    <label class="form-check-label" for="exampleCheck1">Check me out</label>
+  </div>
+  <button type="submit" class="btn btn-primary">Submit</button>
+</form>
+ +

Form text

+

Block-level or inline-level form text can be created using .form-text.

+
+
Associating form text with form controls
+

Form text should be explicitly associated with the form control it relates to using the aria-describedby attribute. This will ensure that assistive technologies—such as screen readers—will announce this form text when the user focuses or enters the control. +

+ +

Form text below inputs can be styled with .form-text. If a block-level element will be used, a top margin is added for easy spacing from the inputs above.

+
+ + +
+ Your password must be 8-20 characters long, contain letters and numbers, and must not contain spaces, special characters, or emoji. +
+
+ html +
+ + +
+ 
<label for="inputPassword5" class="form-label">Password</label>
+<input type="password" id="inputPassword5" class="form-control" aria-describedby="passwordHelpBlock">
+<div id="passwordHelpBlock" class="form-text">
+  Your password must be 8-20 characters long, contain letters and numbers, and must not contain spaces, special characters, or emoji.
+</div>
+ +

Inline text can use any typical inline HTML element (be it a <span>, <small>, or something else) with nothing more than the .form-text class.

+
+
+
+ +
+
+ +
+
+ + Must be 8-20 characters long. + +
+
+
+ html +
+ + +
+ 
<div class="row g-3 align-items-center">
+  <div class="col-auto">
+    <label for="inputPassword6" class="col-form-label">Password</label>
+  </div>
+  <div class="col-auto">
+    <input type="password" id="inputPassword6" class="form-control" aria-describedby="passwordHelpInline">
+  </div>
+  <div class="col-auto">
+    <span id="passwordHelpInline" class="form-text">
+      Must be 8-20 characters long.
+    </span>
+  </div>
+</div>
+ +

Disabled forms

+

Add the disabled boolean attribute on an input to prevent user interactions and make it appear lighter.

+
<input class="form-control" id="disabledInput" type="text" placeholder="Disabled input here..." disabled>
+

Add the disabled attribute to a <fieldset> to disable all the controls within. Browsers treat all native form controls (<input>, <select>, and <button> elements) inside a <fieldset disabled> as disabled, preventing both keyboard and mouse interactions on them.

+

However, if your form also includes custom button-like elements such as <a class="btn btn-*">...</a>, these will only be given a style of pointer-events: none, meaning they are still focusable and operable using the keyboard. In this case, you must manually modify these controls by adding tabindex="-1" to prevent them from receiving focus and aria-disabled="disabled" to signal their state to assistive technologies.

+
+
+
+ Disabled fieldset example +
+ + +
+
+ + +
+
+
+ + +
+
+ +
+
+
+ html +
+ + +
+ 
<form>
+  <fieldset disabled>
+    <legend>Disabled fieldset example</legend>
+    <div class="mb-3">
+      <label for="disabledTextInput" class="form-label">Disabled input</label>
+      <input type="text" id="disabledTextInput" class="form-control" placeholder="Disabled input">
+    </div>
+    <div class="mb-3">
+      <label for="disabledSelect" class="form-label">Disabled select menu</label>
+      <select id="disabledSelect" class="form-select">
+        <option>Disabled select</option>
+      </select>
+    </div>
+    <div class="mb-3">
+      <div class="form-check">
+        <input class="form-check-input" type="checkbox" id="disabledFieldsetCheck" disabled>
+        <label class="form-check-label" for="disabledFieldsetCheck">
+          Can't check this
+        </label>
+      </div>
+    </div>
+    <button type="submit" class="btn btn-primary">Submit</button>
+  </fieldset>
+</form>
+ +

Accessibility

+

Ensure that all form controls have an appropriate accessible name so that their purpose can be conveyed to users of assistive technologies. The simplest way to achieve this is to use a <label> element, or—in the case of buttons—to include sufficiently descriptive text as part of the <button>...</button> content.

+

For situations where it’s not possible to include a visible <label> or appropriate text content, there are alternative ways of still providing an accessible name, such as:

+
    +
  • <label> elements hidden using the .visually-hidden class
    • +
  • Pointing to an existing element that can act as a label using aria-labelledby
    • +
  • Providing a title attribute
    • +
  • Explicitly setting the accessible name on an element using aria-label
    • +
+

If none of these are present, assistive technologies may resort to using the placeholder attribute as a fallback for the accessible name on <input> and <textarea> elements. The examples in this section provide a few suggested, case-specific approaches.

+

While using visually hidden content (.visually-hidden, aria-label, and even placeholder content, which disappears once a form field has content) will benefit assistive technology users, a lack of visible label text may still be problematic for certain users. Some form of visible label is generally the best approach, both for accessibility and usability.

+

Sass

+

Many form variables are set at a general level to be re-used and extended by individual form components. You’ll see these most often as $input-btn-* and $input-* variables.

+

Variables

+

$input-btn-* variables are shared global variables between our buttons and our form components. You’ll find these frequently reassigned as values to other component-specific variables.

+
$input-btn-padding-y:         .375rem;
+$input-btn-padding-x:         .75rem;
+$input-btn-font-family:       null;
+$input-btn-font-size:         $font-size-base;
+$input-btn-line-height:       $line-height-base;
+
+$input-btn-focus-width:         .25rem;
+$input-btn-focus-color-opacity: .25;
+$input-btn-focus-color:         rgba($component-active-bg, $input-btn-focus-color-opacity);
+$input-btn-focus-blur:          0;
+$input-btn-focus-box-shadow:    0 0 $input-btn-focus-blur $input-btn-focus-width $input-btn-focus-color;
+
+$input-btn-padding-y-sm:      .25rem;
+$input-btn-padding-x-sm:      .5rem;
+$input-btn-font-size-sm:      $font-size-sm;
+
+$input-btn-padding-y-lg:      .5rem;
+$input-btn-padding-x-lg:      1rem;
+$input-btn-font-size-lg:      $font-size-lg;
+
+$input-btn-border-width:      var(--#{$prefix}border-width);
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/forms/range/index.html b/docs/5.3/forms/range/index.html new file mode 100644 index 0000000000..f302ef2eb6 --- /dev/null +++ b/docs/5.3/forms/range/index.html @@ -0,0 +1,791 @@ + + + + + + + + + + + + +Range · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Range

+
+

Use our custom range inputs for consistent cross-browser styling and built-in customization.

+ + +
+ + +
+ + On this page +
+
+ +
+
+ + +
+ + +

Overview

+

Create custom <input type="range"> controls with .form-range. The track (the background) and thumb (the value) are both styled to appear the same across browsers. As only Firefox supports “filling” their track from the left or right of the thumb as a means to visually indicate progress, we do not currently support it.

+
+ + +
+ html +
+ + +
+ 
<label for="customRange1" class="form-label">Example range</label>
+<input type="range" class="form-range" id="customRange1">
+ +

Disabled

+

Add the disabled boolean attribute on an input to give it a grayed out appearance, remove pointer events, and prevent focusing.

+
+ + +
+ html +
+ + +
+ 
<label for="disabledRange" class="form-label">Disabled range</label>
+<input type="range" class="form-range" id="disabledRange" disabled>
+ +

Min and max

+

Range inputs have implicit values for min and max—0 and 100, respectively. You may specify new values for those using the min and max attributes.

+
+ + +
+ html +
+ + +
+ 
<label for="customRange2" class="form-label">Example range</label>
+<input type="range" class="form-range" min="0" max="5" id="customRange2">
+ +

Steps

+

By default, range inputs “snap” to integer values. To change this, you can specify a step value. In the example below, we double the number of steps by using step="0.5".

+
+ + +
+ html +
+ + +
+ 
<label for="customRange3" class="form-label">Example range</label>
+<input type="range" class="form-range" min="0" max="5" step="0.5" id="customRange3">
+ +

Sass

+

Variables

+
$form-range-track-width:          100%;
+$form-range-track-height:         .5rem;
+$form-range-track-cursor:         pointer;
+$form-range-track-bg:             var(--#{$prefix}tertiary-bg);
+$form-range-track-border-radius:  1rem;
+$form-range-track-box-shadow:     $box-shadow-inset;
+
+$form-range-thumb-width:                   1rem;
+$form-range-thumb-height:                  $form-range-thumb-width;
+$form-range-thumb-bg:                      $component-active-bg;
+$form-range-thumb-border:                  0;
+$form-range-thumb-border-radius:           1rem;
+$form-range-thumb-box-shadow:              0 .1rem .25rem rgba($black, .1);
+$form-range-thumb-focus-box-shadow:        0 0 0 1px $body-bg, $input-focus-box-shadow;
+$form-range-thumb-focus-box-shadow-width:  $input-focus-width; // For focus box shadow issue in Edge
+$form-range-thumb-active-bg:               tint-color($component-active-bg, 70%);
+$form-range-thumb-disabled-bg:             var(--#{$prefix}secondary-color);
+$form-range-thumb-transition:              background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/forms/select/index.html b/docs/5.3/forms/select/index.html new file mode 100644 index 0000000000..8be06b3656 --- /dev/null +++ b/docs/5.3/forms/select/index.html @@ -0,0 +1,883 @@ + + + + + + + + + + + + +Select · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Select

+
+

Customize the native <select>s with custom CSS that changes the element’s initial appearance.

+ + +
+ + +
+ + On this page +
+
+ +
+
+ + +
+ + +

Default

+

Custom <select> menus need only a custom class, .form-select to trigger the custom styles. Custom styles are limited to the <select>’s initial appearance and cannot modify the <option>s due to browser limitations.

+
+ +
+ html +
+ + +
+ 
<select class="form-select" aria-label="Default select example">
+  <option selected>Open this select menu</option>
+  <option value="1">One</option>
+  <option value="2">Two</option>
+  <option value="3">Three</option>
+</select>
+ +

Sizing

+

You may also choose from small and large custom selects to match our similarly sized text inputs.

+
+ + + +
+ html +
+ + +
+ 
<select class="form-select form-select-lg mb-3" aria-label=".form-select-lg example">
+  <option selected>Open this select menu</option>
+  <option value="1">One</option>
+  <option value="2">Two</option>
+  <option value="3">Three</option>
+</select>
+
+<select class="form-select form-select-sm" aria-label=".form-select-sm example">
+  <option selected>Open this select menu</option>
+  <option value="1">One</option>
+  <option value="2">Two</option>
+  <option value="3">Three</option>
+</select>
+ +

The multiple attribute is also supported:

+
+ +
+ html +
+ + +
+ 
<select class="form-select" multiple aria-label="multiple select example">
+  <option selected>Open this select menu</option>
+  <option value="1">One</option>
+  <option value="2">Two</option>
+  <option value="3">Three</option>
+</select>
+ +

As is the size attribute:

+
+ +
+ html +
+ + +
+ 
<select class="form-select" size="3" aria-label="size 3 select example">
+  <option selected>Open this select menu</option>
+  <option value="1">One</option>
+  <option value="2">Two</option>
+  <option value="3">Three</option>
+</select>
+ +

Disabled

+

Add the disabled boolean attribute on a select to give it a grayed out appearance and remove pointer events.

+
+ +
+ html +
+ + +
+ 
<select class="form-select" aria-label="Disabled select example" disabled>
+  <option selected>Open this select menu</option>
+  <option value="1">One</option>
+  <option value="2">Two</option>
+  <option value="3">Three</option>
+</select>
+ +

Sass

+

Variables

+
$form-select-padding-y:             $input-padding-y;
+$form-select-padding-x:             $input-padding-x;
+$form-select-font-family:           $input-font-family;
+$form-select-font-size:             $input-font-size;
+$form-select-indicator-padding:     $form-select-padding-x * 3; // Extra padding for background-image
+$form-select-font-weight:           $input-font-weight;
+$form-select-line-height:           $input-line-height;
+$form-select-color:                 $input-color;
+$form-select-bg:                    $input-bg;
+$form-select-disabled-color:        null;
+$form-select-disabled-bg:           $input-disabled-bg;
+$form-select-disabled-border-color: $input-disabled-border-color;
+$form-select-bg-position:           right $form-select-padding-x center;
+$form-select-bg-size:               16px 12px; // In pixels because image dimensions
+$form-select-indicator-color:       $gray-800;
+$form-select-indicator:             url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'><path fill='none' stroke='#{$form-select-indicator-color}' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='m2 5 6 6 6-6'/></svg>");
+
+$form-select-feedback-icon-padding-end: $form-select-padding-x * 2.5 + $form-select-indicator-padding;
+$form-select-feedback-icon-position:    center right $form-select-indicator-padding;
+$form-select-feedback-icon-size:        $input-height-inner-half $input-height-inner-half;
+
+$form-select-border-width:        $input-border-width;
+$form-select-border-color:        $input-border-color;
+$form-select-border-radius:       $input-border-radius;
+$form-select-box-shadow:          $box-shadow-inset;
+
+$form-select-focus-border-color:  $input-focus-border-color;
+$form-select-focus-width:         $input-focus-width;
+$form-select-focus-box-shadow:    0 0 0 $form-select-focus-width $input-btn-focus-color;
+
+$form-select-padding-y-sm:        $input-padding-y-sm;
+$form-select-padding-x-sm:        $input-padding-x-sm;
+$form-select-font-size-sm:        $input-font-size-sm;
+$form-select-border-radius-sm:    $input-border-radius-sm;
+
+$form-select-padding-y-lg:        $input-padding-y-lg;
+$form-select-padding-x-lg:        $input-padding-x-lg;
+$form-select-font-size-lg:        $input-font-size-lg;
+$form-select-border-radius-lg:    $input-border-radius-lg;
+
+$form-select-transition:          $input-transition;
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/forms/validation/index.html b/docs/5.3/forms/validation/index.html new file mode 100644 index 0000000000..b528db9d5e --- /dev/null +++ b/docs/5.3/forms/validation/index.html @@ -0,0 +1,1550 @@ + + + + + + + + + + + + +Validation · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Validation

+
+

Provide valuable, actionable feedback to your users with HTML5 form validation, via browser default behaviors or custom styles and JavaScript.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +
+We are aware that currently the client-side custom validation styles and tooltips are not accessible, since they are not exposed to assistive technologies. While we work on a solution, we’d recommend either using the server-side option or the default browser validation method. +
+ +

How it works

+

Here’s how form validation works with Bootstrap:

+
    +
  • HTML form validation is applied via CSS’s two pseudo-classes, :invalid and :valid. It applies to <input>, <select>, and <textarea> elements.
    • +
  • Bootstrap scopes the :invalid and :valid styles to parent .was-validated class, usually applied to the <form>. Otherwise, any required field without a value shows up as invalid on page load. This way, you may choose when to activate them (typically after form submission is attempted).
    • +
  • To reset the appearance of the form (for instance, in the case of dynamic form submissions using Ajax), remove the .was-validated class from the <form> again after submission.
    • +
  • As a fallback, .is-invalid and .is-valid classes may be used instead of the pseudo-classes for server-side validation. They do not require a .was-validated parent class.
    • +
  • Due to constraints in how CSS works, we cannot (at present) apply styles to a <label> that comes before a form control in the DOM without the help of custom JavaScript.
    • +
  • All modern browsers support the constraint validation API, a series of JavaScript methods for validating form controls.
    • +
  • Feedback messages may utilize the browser defaults (different for each browser, and unstylable via CSS) or our custom feedback styles with additional HTML and CSS.
    • +
  • You may provide custom validity messages with setCustomValidity in JavaScript.
    • +
+

With that in mind, consider the following demos for our custom form validation styles, optional server-side classes, and browser defaults.

+

Custom styles

+

For custom Bootstrap form validation messages, you’ll need to add the novalidate boolean attribute to your <form>. This disables the browser default feedback tooltips, but still provides access to the form validation APIs in JavaScript. Try to submit the form below; our JavaScript will intercept the submit button and relay feedback to you. When attempting to submit, you’ll see the :invalid and :valid styles applied to your form controls.

+

Custom feedback styles apply custom colors, borders, focus styles, and background icons to better communicate feedback. Background icons for <select>s are only available with .form-select, and not .form-control.

+
+
+
+ + +
+ Looks good! +
+
+
+ + +
+ Looks good! +
+
+
+ +
+ @ + +
+ Please choose a username. +
+
+
+
+ + +
+ Please provide a valid city. +
+
+
+ + +
+ Please select a valid state. +
+
+
+ + +
+ Please provide a valid zip. +
+
+
+
+ + +
+ You must agree before submitting. +
+
+
+
+ +
+
+
+ html +
+ + +
+ 
<form class="row g-3 needs-validation" novalidate>
+  <div class="col-md-4">
+    <label for="validationCustom01" class="form-label">First name</label>
+    <input type="text" class="form-control" id="validationCustom01" value="Mark" required>
+    <div class="valid-feedback">
+      Looks good!
+    </div>
+  </div>
+  <div class="col-md-4">
+    <label for="validationCustom02" class="form-label">Last name</label>
+    <input type="text" class="form-control" id="validationCustom02" value="Otto" required>
+    <div class="valid-feedback">
+      Looks good!
+    </div>
+  </div>
+  <div class="col-md-4">
+    <label for="validationCustomUsername" class="form-label">Username</label>
+    <div class="input-group has-validation">
+      <span class="input-group-text" id="inputGroupPrepend">@</span>
+      <input type="text" class="form-control" id="validationCustomUsername" aria-describedby="inputGroupPrepend" required>
+      <div class="invalid-feedback">
+        Please choose a username.
+      </div>
+    </div>
+  </div>
+  <div class="col-md-6">
+    <label for="validationCustom03" class="form-label">City</label>
+    <input type="text" class="form-control" id="validationCustom03" required>
+    <div class="invalid-feedback">
+      Please provide a valid city.
+    </div>
+  </div>
+  <div class="col-md-3">
+    <label for="validationCustom04" class="form-label">State</label>
+    <select class="form-select" id="validationCustom04" required>
+      <option selected disabled value="">Choose...</option>
+      <option>...</option>
+    </select>
+    <div class="invalid-feedback">
+      Please select a valid state.
+    </div>
+  </div>
+  <div class="col-md-3">
+    <label for="validationCustom05" class="form-label">Zip</label>
+    <input type="text" class="form-control" id="validationCustom05" required>
+    <div class="invalid-feedback">
+      Please provide a valid zip.
+    </div>
+  </div>
+  <div class="col-12">
+    <div class="form-check">
+      <input class="form-check-input" type="checkbox" value="" id="invalidCheck" required>
+      <label class="form-check-label" for="invalidCheck">
+        Agree to terms and conditions
+      </label>
+      <div class="invalid-feedback">
+        You must agree before submitting.
+      </div>
+    </div>
+  </div>
+  <div class="col-12">
+    <button class="btn btn-primary" type="submit">Submit form</button>
+  </div>
+</form>
+ +
// Example starter JavaScript for disabling form submissions if there are invalid fields
+(() => {
+  'use strict'
+
+  // Fetch all the forms we want to apply custom Bootstrap validation styles to
+  const forms = document.querySelectorAll('.needs-validation')
+
+  // Loop over them and prevent submission
+  Array.from(forms).forEach(form => {
+    form.addEventListener('submit', event => {
+      if (!form.checkValidity()) {
+        event.preventDefault()
+        event.stopPropagation()
+      }
+
+      form.classList.add('was-validated')
+    }, false)
+  })
+})()
+ +

Browser defaults

+

Not interested in custom validation feedback messages or writing JavaScript to change form behaviors? All good, you can use the browser defaults. Try submitting the form below. Depending on your browser and OS, you’ll see a slightly different style of feedback.

+

While these feedback styles cannot be styled with CSS, you can still customize the feedback text through JavaScript.

+
+
+
+ + +
+
+ + +
+
+ +
+ @ + +
+
+
+ + +
+
+ + +
+
+ + +
+
+
+ + +
+
+
+ +
+
+
+ html +
+ + +
+ 
<form class="row g-3">
+  <div class="col-md-4">
+    <label for="validationDefault01" class="form-label">First name</label>
+    <input type="text" class="form-control" id="validationDefault01" value="Mark" required>
+  </div>
+  <div class="col-md-4">
+    <label for="validationDefault02" class="form-label">Last name</label>
+    <input type="text" class="form-control" id="validationDefault02" value="Otto" required>
+  </div>
+  <div class="col-md-4">
+    <label for="validationDefaultUsername" class="form-label">Username</label>
+    <div class="input-group">
+      <span class="input-group-text" id="inputGroupPrepend2">@</span>
+      <input type="text" class="form-control" id="validationDefaultUsername"  aria-describedby="inputGroupPrepend2" required>
+    </div>
+  </div>
+  <div class="col-md-6">
+    <label for="validationDefault03" class="form-label">City</label>
+    <input type="text" class="form-control" id="validationDefault03" required>
+  </div>
+  <div class="col-md-3">
+    <label for="validationDefault04" class="form-label">State</label>
+    <select class="form-select" id="validationDefault04" required>
+      <option selected disabled value="">Choose...</option>
+      <option>...</option>
+    </select>
+  </div>
+  <div class="col-md-3">
+    <label for="validationDefault05" class="form-label">Zip</label>
+    <input type="text" class="form-control" id="validationDefault05" required>
+  </div>
+  <div class="col-12">
+    <div class="form-check">
+      <input class="form-check-input" type="checkbox" value="" id="invalidCheck2" required>
+      <label class="form-check-label" for="invalidCheck2">
+        Agree to terms and conditions
+      </label>
+    </div>
+  </div>
+  <div class="col-12">
+    <button class="btn btn-primary" type="submit">Submit form</button>
+  </div>
+</form>
+ +

Server-side

+

We recommend using client-side validation, but in case you require server-side validation, you can indicate invalid and valid form fields with .is-invalid and .is-valid. Note that .invalid-feedback is also supported with these classes.

+

For invalid fields, ensure that the invalid feedback/error message is associated with the relevant form field using aria-describedby (noting that this attribute allows more than one id to be referenced, in case the field already points to additional form text).

+

To fix issues with border radius, input groups require an additional .has-validation class.

+
+
+
+ + +
+ Looks good! +
+
+
+ + +
+ Looks good! +
+
+
+ +
+ @ + +
+ Please choose a username. +
+
+
+
+ + +
+ Please provide a valid city. +
+
+
+ + +
+ Please select a valid state. +
+
+
+ + +
+ Please provide a valid zip. +
+
+
+
+ + +
+ You must agree before submitting. +
+
+
+
+ +
+
+
+ html +
+ + +
+ 
<form class="row g-3">
+  <div class="col-md-4">
+    <label for="validationServer01" class="form-label">First name</label>
+    <input type="text" class="form-control is-valid" id="validationServer01" value="Mark" required>
+    <div class="valid-feedback">
+      Looks good!
+    </div>
+  </div>
+  <div class="col-md-4">
+    <label for="validationServer02" class="form-label">Last name</label>
+    <input type="text" class="form-control is-valid" id="validationServer02" value="Otto" required>
+    <div class="valid-feedback">
+      Looks good!
+    </div>
+  </div>
+  <div class="col-md-4">
+    <label for="validationServerUsername" class="form-label">Username</label>
+    <div class="input-group has-validation">
+      <span class="input-group-text" id="inputGroupPrepend3">@</span>
+      <input type="text" class="form-control is-invalid" id="validationServerUsername" aria-describedby="inputGroupPrepend3 validationServerUsernameFeedback" required>
+      <div id="validationServerUsernameFeedback" class="invalid-feedback">
+        Please choose a username.
+      </div>
+    </div>
+  </div>
+  <div class="col-md-6">
+    <label for="validationServer03" class="form-label">City</label>
+    <input type="text" class="form-control is-invalid" id="validationServer03" aria-describedby="validationServer03Feedback" required>
+    <div id="validationServer03Feedback" class="invalid-feedback">
+      Please provide a valid city.
+    </div>
+  </div>
+  <div class="col-md-3">
+    <label for="validationServer04" class="form-label">State</label>
+    <select class="form-select is-invalid" id="validationServer04" aria-describedby="validationServer04Feedback" required>
+      <option selected disabled value="">Choose...</option>
+      <option>...</option>
+    </select>
+    <div id="validationServer04Feedback" class="invalid-feedback">
+      Please select a valid state.
+    </div>
+  </div>
+  <div class="col-md-3">
+    <label for="validationServer05" class="form-label">Zip</label>
+    <input type="text" class="form-control is-invalid" id="validationServer05" aria-describedby="validationServer05Feedback" required>
+    <div id="validationServer05Feedback" class="invalid-feedback">
+      Please provide a valid zip.
+    </div>
+  </div>
+  <div class="col-12">
+    <div class="form-check">
+      <input class="form-check-input is-invalid" type="checkbox" value="" id="invalidCheck3" aria-describedby="invalidCheck3Feedback" required>
+      <label class="form-check-label" for="invalidCheck3">
+        Agree to terms and conditions
+      </label>
+      <div id="invalidCheck3Feedback" class="invalid-feedback">
+        You must agree before submitting.
+      </div>
+    </div>
+  </div>
+  <div class="col-12">
+    <button class="btn btn-primary" type="submit">Submit form</button>
+  </div>
+</form>
+ +

Supported elements

+

Validation styles are available for the following form controls and components:

+
    +
  • <input>s and <textarea>s with .form-control (including up to one .form-control in input groups)
    • +
  • <select>s with .form-select
    • +
  • .form-checks
    • +
+
+
+
+ + +
+ Please enter a message in the textarea. +
+
+ +
+ + +
Example invalid feedback text
+
+ +
+ + +
+
+ + +
More example invalid feedback text
+
+ +
+ +
Example invalid select feedback
+
+ +
+ +
Example invalid form file feedback
+
+ +
+ +
+
+
+ html +
+ + +
+ 
<form class="was-validated">
+  <div class="mb-3">
+    <label for="validationTextarea" class="form-label">Textarea</label>
+    <textarea class="form-control" id="validationTextarea" placeholder="Required example textarea" required></textarea>
+    <div class="invalid-feedback">
+      Please enter a message in the textarea.
+    </div>
+  </div>
+
+  <div class="form-check mb-3">
+    <input type="checkbox" class="form-check-input" id="validationFormCheck1" required>
+    <label class="form-check-label" for="validationFormCheck1">Check this checkbox</label>
+    <div class="invalid-feedback">Example invalid feedback text</div>
+  </div>
+
+  <div class="form-check">
+    <input type="radio" class="form-check-input" id="validationFormCheck2" name="radio-stacked" required>
+    <label class="form-check-label" for="validationFormCheck2">Toggle this radio</label>
+  </div>
+  <div class="form-check mb-3">
+    <input type="radio" class="form-check-input" id="validationFormCheck3" name="radio-stacked" required>
+    <label class="form-check-label" for="validationFormCheck3">Or toggle this other radio</label>
+    <div class="invalid-feedback">More example invalid feedback text</div>
+  </div>
+
+  <div class="mb-3">
+    <select class="form-select" required aria-label="select example">
+      <option value="">Open this select menu</option>
+      <option value="1">One</option>
+      <option value="2">Two</option>
+      <option value="3">Three</option>
+    </select>
+    <div class="invalid-feedback">Example invalid select feedback</div>
+  </div>
+
+  <div class="mb-3">
+    <input type="file" class="form-control" aria-label="file example" required>
+    <div class="invalid-feedback">Example invalid form file feedback</div>
+  </div>
+
+  <div class="mb-3">
+    <button class="btn btn-primary" type="submit" disabled>Submit form</button>
+  </div>
+</form>
+ +

Tooltips

+

If your form layout allows it, you can swap the .{valid|invalid}-feedback classes for .{valid|invalid}-tooltip classes to display validation feedback in a styled tooltip. Be sure to have a parent with position: relative on it for tooltip positioning. In the example below, our column classes have this already, but your project may require an alternative setup.

+
+
+
+ + +
+ Looks good! +
+
+
+ + +
+ Looks good! +
+
+
+ +
+ @ + +
+ Please choose a unique and valid username. +
+
+
+
+ + +
+ Please provide a valid city. +
+
+
+ + +
+ Please select a valid state. +
+
+
+ + +
+ Please provide a valid zip. +
+
+
+ +
+
+
+ html +
+ + +
+ 
<form class="row g-3 needs-validation" novalidate>
+  <div class="col-md-4 position-relative">
+    <label for="validationTooltip01" class="form-label">First name</label>
+    <input type="text" class="form-control" id="validationTooltip01" value="Mark" required>
+    <div class="valid-tooltip">
+      Looks good!
+    </div>
+  </div>
+  <div class="col-md-4 position-relative">
+    <label for="validationTooltip02" class="form-label">Last name</label>
+    <input type="text" class="form-control" id="validationTooltip02" value="Otto" required>
+    <div class="valid-tooltip">
+      Looks good!
+    </div>
+  </div>
+  <div class="col-md-4 position-relative">
+    <label for="validationTooltipUsername" class="form-label">Username</label>
+    <div class="input-group has-validation">
+      <span class="input-group-text" id="validationTooltipUsernamePrepend">@</span>
+      <input type="text" class="form-control" id="validationTooltipUsername" aria-describedby="validationTooltipUsernamePrepend" required>
+      <div class="invalid-tooltip">
+        Please choose a unique and valid username.
+      </div>
+    </div>
+  </div>
+  <div class="col-md-6 position-relative">
+    <label for="validationTooltip03" class="form-label">City</label>
+    <input type="text" class="form-control" id="validationTooltip03" required>
+    <div class="invalid-tooltip">
+      Please provide a valid city.
+    </div>
+  </div>
+  <div class="col-md-3 position-relative">
+    <label for="validationTooltip04" class="form-label">State</label>
+    <select class="form-select" id="validationTooltip04" required>
+      <option selected disabled value="">Choose...</option>
+      <option>...</option>
+    </select>
+    <div class="invalid-tooltip">
+      Please select a valid state.
+    </div>
+  </div>
+  <div class="col-md-3 position-relative">
+    <label for="validationTooltip05" class="form-label">Zip</label>
+    <input type="text" class="form-control" id="validationTooltip05" required>
+    <div class="invalid-tooltip">
+      Please provide a valid zip.
+    </div>
+  </div>
+  <div class="col-12">
+    <button class="btn btn-primary" type="submit">Submit form</button>
+  </div>
+</form>
+ +

Sass

+

Variables

+
$form-feedback-margin-top:          $form-text-margin-top;
+$form-feedback-font-size:           $form-text-font-size;
+$form-feedback-font-style:          $form-text-font-style;
+$form-feedback-valid-color:         $success;
+$form-feedback-invalid-color:       $danger;
+
+$form-feedback-icon-valid-color:    $form-feedback-valid-color;
+$form-feedback-icon-valid:          url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 8 8'><path fill='#{$form-feedback-icon-valid-color}' d='M2.3 6.73.6 4.53c-.4-1.04.46-1.4 1.1-.8l1.1 1.4 3.4-3.8c.6-.63 1.6-.27 1.2.7l-4 4.6c-.43.5-.8.4-1.1.1z'/></svg>");
+$form-feedback-icon-invalid-color:  $form-feedback-invalid-color;
+$form-feedback-icon-invalid:        url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 12 12' width='12' height='12' fill='none' stroke='#{$form-feedback-icon-invalid-color}'><circle cx='6' cy='6' r='4.5'/><path stroke-linejoin='round' d='M5.8 3.6h.4L6 6.5z'/><circle cx='6' cy='8.2' r='.6' fill='#{$form-feedback-icon-invalid-color}' stroke='none'/></svg>");
+
+

Mixins

+

Two mixins are combined together, through our loop, to generate our form validation feedback styles.

+
@mixin form-validation-state-selector($state) {
+  @if ($state == "valid" or $state == "invalid") {
+    .was-validated #{if(&, "&", "")}:#{$state},
+    #{if(&, "&", "")}.is-#{$state} {
+      @content;
+    }
+  } @else {
+    #{if(&, "&", "")}.is-#{$state} {
+      @content;
+    }
+  }
+}
+
+@mixin form-validation-state(
+  $state,
+  $color,
+  $icon,
+  $tooltip-color: color-contrast($color),
+  $tooltip-bg-color: rgba($color, $form-feedback-tooltip-opacity),
+  $focus-box-shadow: 0 0 $input-btn-focus-blur $input-focus-width rgba($color, $input-btn-focus-color-opacity),
+  $border-color: $color
+) {
+  .#{$state}-feedback {
+    display: none;
+    width: 100%;
+    margin-top: $form-feedback-margin-top;
+    @include font-size($form-feedback-font-size);
+    font-style: $form-feedback-font-style;
+    color: $color;
+  }
+
+  .#{$state}-tooltip {
+    position: absolute;
+    top: 100%;
+    z-index: 5;
+    display: none;
+    max-width: 100%; // Contain to parent when possible
+    padding: $form-feedback-tooltip-padding-y $form-feedback-tooltip-padding-x;
+    margin-top: .1rem;
+    @include font-size($form-feedback-tooltip-font-size);
+    line-height: $form-feedback-tooltip-line-height;
+    color: $tooltip-color;
+    background-color: $tooltip-bg-color;
+    @include border-radius($form-feedback-tooltip-border-radius);
+  }
+
+  @include form-validation-state-selector($state) {
+    ~ .#{$state}-feedback,
+    ~ .#{$state}-tooltip {
+      display: block;
+    }
+  }
+
+  .form-control {
+    @include form-validation-state-selector($state) {
+      border-color: $border-color;
+
+      @if $enable-validation-icons {
+        padding-right: $input-height-inner;
+        background-image: escape-svg($icon);
+        background-repeat: no-repeat;
+        background-position: right $input-height-inner-quarter center;
+        background-size: $input-height-inner-half $input-height-inner-half;
+      }
+
+      &:focus {
+        border-color: $border-color;
+        box-shadow: $focus-box-shadow;
+      }
+    }
+  }
+
+  // stylelint-disable-next-line selector-no-qualifying-type
+  textarea.form-control {
+    @include form-validation-state-selector($state) {
+      @if $enable-validation-icons {
+        padding-right: $input-height-inner;
+        background-position: top $input-height-inner-quarter right $input-height-inner-quarter;
+      }
+    }
+  }
+
+  .form-select {
+    @include form-validation-state-selector($state) {
+      border-color: $border-color;
+
+      @if $enable-validation-icons {
+        &:not([multiple]):not([size]),
+        &:not([multiple])[size="1"] {
+          --#{$prefix}form-select-bg-icon: #{escape-svg($icon)};
+          padding-right: $form-select-feedback-icon-padding-end;
+          background-position: $form-select-bg-position, $form-select-feedback-icon-position;
+          background-size: $form-select-bg-size, $form-select-feedback-icon-size;
+        }
+      }
+
+      &:focus {
+        border-color: $border-color;
+        box-shadow: $focus-box-shadow;
+      }
+    }
+  }
+
+  .form-control-color {
+    @include form-validation-state-selector($state) {
+      @if $enable-validation-icons {
+        width: add($form-color-width, $input-height-inner);
+      }
+    }
+  }
+
+  .form-check-input {
+    @include form-validation-state-selector($state) {
+      border-color: $border-color;
+
+      &:checked {
+        background-color: $color;
+      }
+
+      &:focus {
+        box-shadow: $focus-box-shadow;
+      }
+
+      ~ .form-check-label {
+        color: $color;
+      }
+    }
+  }
+  .form-check-inline .form-check-input {
+    ~ .#{$state}-feedback {
+      margin-left: .5em;
+    }
+  }
+
+  .input-group {
+    > .form-control:not(:focus),
+    > .form-select:not(:focus),
+    > .form-floating:not(:focus-within) {
+      @include form-validation-state-selector($state) {
+        @if $state == "valid" {
+          z-index: 3;
+        } @else if $state == "invalid" {
+          z-index: 4;
+        }
+      }
+    }
+  }
+}
+
+

Map

+

This is the validation Sass map from _variables.scss. Override or extend this to generate different or additional states.

+
$form-validation-states: (
+  "valid": (
+    "color": var(--#{$prefix}success-text),
+    "icon": $form-feedback-icon-valid,
+    "tooltip-color": #fff,
+    "tooltip-bg-color": var(--#{$prefix}success),
+    "focus-box-shadow": 0 0 $input-btn-focus-blur $input-focus-width rgba(var(--#{$prefix}success-rgb), $input-btn-focus-color-opacity),
+    "border-color": var(--#{$prefix}success),
+  ),
+  "invalid": (
+    "color": var(--#{$prefix}danger-text),
+    "icon": $form-feedback-icon-invalid,
+    "tooltip-color": #fff,
+    "tooltip-bg-color": var(--#{$prefix}danger),
+    "focus-box-shadow": 0 0 $input-btn-focus-blur $input-focus-width rgba(var(--#{$prefix}danger-rgb), $input-btn-focus-color-opacity),
+    "border-color": var(--#{$prefix}danger),
+  )
+);
+
+

Maps of $form-validation-states can contain three optional parameters to override tooltips and focus styles.

+

Loop

+

Used to iterate over $form-validation-states map values to generate our validation styles. Any modifications to the above Sass map will be reflected in your compiled CSS via this loop.

+
@each $state, $data in $form-validation-states {
+  @include form-validation-state($state, $data...);
+}
+
+

Customizing

+

Validation states can be customized via Sass with the $form-validation-states map. Located in our _variables.scss file, this Sass map is how we generate the default valid/invalid validation states. Included is a nested map for customizing each state’s color, icon, tooltip color, and focus shadow. While no other states are supported by browsers, those using custom styles can easily add more complex form feedback.

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/accessibility/index.html b/docs/5.3/getting-started/accessibility/index.html new file mode 100644 index 0000000000..97d513bd16 --- /dev/null +++ b/docs/5.3/getting-started/accessibility/index.html @@ -0,0 +1,732 @@ + + + + + + + + + + + + +Accessibility · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Accessibility

+
+

A brief overview of Bootstrap’s features and limitations for the creation of accessible content.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Bootstrap provides an easy-to-use framework of ready-made styles, layout tools, and interactive components, allowing developers to create websites and applications that are visually appealing, functionally rich, and accessible out of the box.

+

Overview and limitations

+

The overall accessibility of any project built with Bootstrap depends in large part on the author’s markup, additional styling, and scripting they’ve included. However, provided that these have been implemented correctly, it should be perfectly possible to create websites and applications with Bootstrap that fulfill WCAG 2.1 (A/AA/AAA), Section 508, and similar accessibility standards and requirements.

+

Structural markup

+

Bootstrap’s styling and layout can be applied to a wide range of markup structures. This documentation aims to provide developers with best practice examples to demonstrate the use of Bootstrap itself and illustrate appropriate semantic markup, including ways in which potential accessibility concerns can be addressed.

+

Interactive components

+

Bootstrap’s interactive components—such as modal dialogs, dropdown menus, and custom tooltips—are designed to work for touch, mouse, and keyboard users. Through the use of relevant WAI-ARIA roles and attributes, these components should also be understandable and operable using assistive technologies (such as screen readers).

+

Because Bootstrap’s components are purposely designed to be fairly generic, authors may need to include further ARIA roles and attributes, as well as JavaScript behavior, to more accurately convey the precise nature and functionality of their component. This is usually noted in the documentation.

+

Color contrast

+

Some combinations of colors that currently make up Bootstrap’s default palette—used throughout the framework for things such as button variations, alert variations, form validation indicators—may lead to insufficient color contrast (below the recommended WCAG 2.1 text color contrast ratio of 4.5:1 and the WCAG 2.1 non-text color contrast ratio of 3:1), particularly when used against a light background. Authors are encouraged to test their specific uses of color and, where necessary, manually modify/extend these default colors to ensure adequate color contrast ratios.

+

Visually hidden content

+

Content which should be visually hidden, but remain accessible to assistive technologies such as screen readers, can be styled using the .visually-hidden class. This can be useful in situations where additional visual information or cues (such as meaning denoted through the use of color) need to also be conveyed to non-visual users.

+
<p class="text-danger">
+  <span class="visually-hidden">Danger: </span>
+  This action is not reversible
+</p>
+

For visually hidden interactive controls, such as traditional “skip” links, use the .visually-hidden-focusable class. This will ensure that the control becomes visible once focused (for sighted keyboard users). Watch out, compared to the equivalent .sr-only and .sr-only-focusable classes in past versions, Bootstrap 5’s .visually-hidden-focusable is a standalone class, and must not be used in combination with the .visually-hidden class.

+
<a class="visually-hidden-focusable" href="#content">Skip to main content</a>
+

Reduced motion

+

Bootstrap includes support for the prefers-reduced-motion media feature. In browsers/environments that allow the user to specify their preference for reduced motion, most CSS transition effects in Bootstrap (for instance, when a modal dialog is opened or closed, or the sliding animation in carousels) will be disabled, and meaningful animations (such as spinners) will be slowed down.

+

On browsers that support prefers-reduced-motion, and where the user has not explicitly signaled that they’d prefer reduced motion (i.e. where prefers-reduced-motion: no-preference), Bootstrap enables smooth scrolling using the scroll-behavior property.

+

Additional resources

+ + +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/best-practices/index.html b/docs/5.3/getting-started/best-practices/index.html new file mode 100644 index 0000000000..01c9df830f --- /dev/null +++ b/docs/5.3/getting-started/best-practices/index.html @@ -0,0 +1,687 @@ + + + + + + + + + + + + +Best practices · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Best practices

+
+

Learn about some of the best practices we’ve gathered from years of working on and using Bootstrap.

+ + +
+ + + +
+ + +

We’ve designed and developed Bootstrap to work in a number of environments. Here are some of the best practices we’ve gathered from years of working on and using it ourselves.

+
+Heads up! This copy is a work in progress. +
+ +

General outline

+
    +
  • Working with CSS
    • +
  • Working with Sass files
    • +
  • Building new CSS components
    • +
  • Working with flexbox
    • +
  • Ask in our GitHub Discussions
    • +
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/browsers-devices/index.html b/docs/5.3/getting-started/browsers-devices/index.html new file mode 100644 index 0000000000..f1ec9e6d01 --- /dev/null +++ b/docs/5.3/getting-started/browsers-devices/index.html @@ -0,0 +1,801 @@ + + + + + + + + + + + + +Browsers and devices · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Browsers and devices

+
+

Learn about the browsers and devices, from modern to old, that are supported by Bootstrap, including known quirks and bugs for each.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Supported browsers

+

Bootstrap supports the latest, stable releases of all major browsers and platforms.

+

Alternative browsers which use the latest version of WebKit, Blink, or Gecko, whether directly or via the platform’s web view API, are not explicitly supported. However, Bootstrap should (in most cases) display and function correctly in these browsers as well. More specific support information is provided below.

+

You can find our supported range of browsers and their versions in our .browserslistrc file:

+
# https://github.com/browserslist/browserslist#readme
+
+>= 0.5%
+last 2 major versions
+not dead
+Chrome >= 60
+Firefox >= 60
+Firefox ESR
+iOS >= 12
+Safari >= 12
+not Explorer <= 11
+

We use Autoprefixer to handle intended browser support via CSS prefixes, which uses Browserslist to manage these browser versions. Consult their documentation for how to integrate these tools into your projects.

+

Mobile devices

+

Generally speaking, Bootstrap supports the latest versions of each major platform’s default browsers. Note that proxy browsers (such as Opera Mini, Opera Mobile’s Turbo mode, UC Browser Mini, Amazon Silk) are not supported.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
ChromeFirefoxSafariAndroid Browser & WebView
AndroidSupportedSupported—v6.0+
iOSSupportedSupportedSupported—
+ +

Desktop browsers

+

Similarly, the latest versions of most desktop browsers are supported.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ChromeFirefoxMicrosoft EdgeOperaSafari
MacSupportedSupportedSupportedSupportedSupported
WindowsSupportedSupportedSupportedSupported—
+ +

For Firefox, in addition to the latest normal stable release, we also support the latest Extended Support Release (ESR) version of Firefox.

+

Unofficially, Bootstrap should look and behave well enough in Chromium and Chrome for Linux, and Firefox for Linux, though they are not officially supported.

+

Internet Explorer

+

Internet Explorer is not supported. If you require Internet Explorer support, please use Bootstrap v4.

+

Modals and dropdowns on mobile

+

Overflow and scrolling

+

Support for overflow: hidden; on the <body> element is quite limited in iOS and Android. To that end, when you scroll past the top or bottom of a modal in either of those devices’ browsers, the <body> content will begin to scroll. See Chrome bug #175502 (fixed in Chrome v40) and WebKit bug #153852.

+

iOS text fields and scrolling

+

As of iOS 9.2, while a modal is open, if the initial touch of a scroll gesture is within the boundary of a textual <input> or a <textarea>, the <body> content underneath the modal will be scrolled instead of the modal itself. See WebKit bug #153856.

+ +

The .dropdown-backdrop element isn’t used on iOS in the nav because of the complexity of z-indexing. Thus, to close dropdowns in navbars, you must directly click the dropdown element (or any other element which will fire a click event in iOS).

+

Browser zooming

+

Page zooming inevitably presents rendering artifacts in some components, both in Bootstrap and the rest of the web. Depending on the issue, we may be able to fix it (search first and then open an issue if need be). However, we tend to ignore these as they often have no direct solution other than hacky workarounds.

+

Validators

+

In order to provide the best possible experience to old and buggy browsers, Bootstrap uses CSS browser hacks in several places to target special CSS to certain browser versions in order to work around bugs in the browsers themselves. These hacks understandably cause CSS validators to complain that they are invalid. In a couple places, we also use bleeding-edge CSS features that aren’t yet fully standardized, but these are used purely for progressive enhancement.

+

These validation warnings don’t matter in practice since the non-hacky portion of our CSS does fully validate and the hacky portions don’t interfere with the proper functioning of the non-hacky portion, hence why we deliberately ignore these particular warnings.

+

Our HTML docs likewise have some trivial and inconsequential HTML validation warnings due to our inclusion of a workaround for a certain Firefox bug.

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/build-tools/index.html b/docs/5.3/getting-started/build-tools/index.html new file mode 100644 index 0000000000..6a806fa1ba --- /dev/null +++ b/docs/5.3/getting-started/build-tools/index.html @@ -0,0 +1,12 @@ + + + + + + https://getbootstrap.com/docs/5.3/getting-started/contribute/ + + + + + + diff --git a/docs/5.3/getting-started/contents/index.html b/docs/5.3/getting-started/contents/index.html new file mode 100644 index 0000000000..ba1c8f584a --- /dev/null +++ b/docs/5.3/getting-started/contents/index.html @@ -0,0 +1,827 @@ + + + + + + + + + + + + +Contents · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Contents

+
+

Discover what’s included in Bootstrap, including our compiled and source code flavors.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Compiled Bootstrap

+

Once downloaded, unzip the compressed folder and you’ll see something like this:

+ +
bootstrap/
+├── css/
+│   ├── bootstrap-grid.css
+│   ├── bootstrap-grid.css.map
+│   ├── bootstrap-grid.min.css
+│   ├── bootstrap-grid.min.css.map
+│   ├── bootstrap-grid.rtl.css
+│   ├── bootstrap-grid.rtl.css.map
+│   ├── bootstrap-grid.rtl.min.css
+│   ├── bootstrap-grid.rtl.min.css.map
+│   ├── bootstrap-reboot.css
+│   ├── bootstrap-reboot.css.map
+│   ├── bootstrap-reboot.min.css
+│   ├── bootstrap-reboot.min.css.map
+│   ├── bootstrap-reboot.rtl.css
+│   ├── bootstrap-reboot.rtl.css.map
+│   ├── bootstrap-reboot.rtl.min.css
+│   ├── bootstrap-reboot.rtl.min.css.map
+│   ├── bootstrap-utilities.css
+│   ├── bootstrap-utilities.css.map
+│   ├── bootstrap-utilities.min.css
+│   ├── bootstrap-utilities.min.css.map
+│   ├── bootstrap-utilities.rtl.css
+│   ├── bootstrap-utilities.rtl.css.map
+│   ├── bootstrap-utilities.rtl.min.css
+│   ├── bootstrap-utilities.rtl.min.css.map
+│   ├── bootstrap.css
+│   ├── bootstrap.css.map
+│   ├── bootstrap.min.css
+│   ├── bootstrap.min.css.map
+│   ├── bootstrap.rtl.css
+│   ├── bootstrap.rtl.css.map
+│   ├── bootstrap.rtl.min.css
+│   └── bootstrap.rtl.min.css.map
+└── js/
+    ├── bootstrap.bundle.js
+    ├── bootstrap.bundle.js.map
+    ├── bootstrap.bundle.min.js
+    ├── bootstrap.bundle.min.js.map
+    ├── bootstrap.esm.js
+    ├── bootstrap.esm.js.map
+    ├── bootstrap.esm.min.js
+    ├── bootstrap.esm.min.js.map
+    ├── bootstrap.js
+    ├── bootstrap.js.map
+    ├── bootstrap.min.js
+    └── bootstrap.min.js.map
+

This is the most basic form of Bootstrap: compiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (bootstrap.*), as well as compiled and minified CSS and JS (bootstrap.min.*). Source maps (bootstrap.*.map) are available for use with certain browsers’ developer tools. Bundled JS files (bootstrap.bundle.js and minified bootstrap.bundle.min.js) include Popper.

+

CSS files

+

Bootstrap includes a handful of options for including some or all of our compiled CSS.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CSS filesLayoutContentComponentsUtilities
bootstrap.css
bootstrap.min.css
bootstrap.rtl.css
bootstrap.rtl.min.css		IncludedIncludedIncludedIncluded
bootstrap-grid.css
bootstrap-grid.rtl.css
bootstrap-grid.min.css
bootstrap-grid.rtl.min.css		Only grid system——Only flex utilities
bootstrap-utilities.css
bootstrap-utilities.rtl.css
bootstrap-utilities.min.css
bootstrap-utilities.rtl.min.css		———Included
bootstrap-reboot.css
bootstrap-reboot.rtl.css
bootstrap-reboot.min.css
bootstrap-reboot.rtl.min.css		—Only Reboot——
+ +

JS files

+

Similarly, we have options for including some or all of our compiled JavaScript.

+
+ + + + + + + + + + + + + + + + +
JS FilesPopper
bootstrap.bundle.js
bootstrap.bundle.min.js
Included
bootstrap.js
bootstrap.min.js
–
+ +

Bootstrap source code

+

The Bootstrap source code download includes the compiled CSS and JavaScript assets, along with source Sass, JavaScript, and documentation. More specifically, it includes the following and more:

+
bootstrap/
+├── dist/
+│   ├── css/
+│   └── js/
+├── site/
+│   └──content/
+│      └── docs/
+│          └── 5.3/
+│              └── examples/
+├── js/
+└── scss/
+

The scss/ and js/ are the source code for our CSS and JavaScript. The dist/ folder includes everything listed in the compiled download section above. The site/content/docs/ folder includes the source code for our hosted documentation, including our live examples of Bootstrap usage.

+

Beyond that, any other included file provides support for packages, license information, and development.

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/contribute/index.html b/docs/5.3/getting-started/contribute/index.html new file mode 100644 index 0000000000..aa610c957f --- /dev/null +++ b/docs/5.3/getting-started/contribute/index.html @@ -0,0 +1,756 @@ + + + + + + + + + + + + +Contribute · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Contribute

+
+

Help develop Bootstrap with our documentation build scripts and tests.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Tooling setup

+

Bootstrap uses npm scripts to build the documentation and compile source files. Our package.json houses these scripts for compiling code, running tests, and more. These aren’t intended for use outside our repository and documentation.

+

To use our build system and run our documentation locally, you’ll need a copy of Bootstrap’s source files and Node. Follow these steps and you should be ready to rock:

+
    +
  1. Download and install Node.js, which we use to manage our dependencies.
    2. +
  2. Either download Bootstrap’s sources or fork and clone Bootstrap’s repository.
    3. +
  3. Navigate to the root /bootstrap directory and run npm install to install our local dependencies listed in package.json.
    4. +
+

When completed, you’ll be able to run the various commands provided from the command line.

+

Using npm scripts

+

Our package.json includes numerous tasks for developing the project. Run npm run to see all the npm scripts in your terminal. Primary tasks include:

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
TaskDescription
npm startCompiles CSS and JavaScript, builds the documentation, and starts a local server.
npm run distCreates the dist/ directory with compiled files. Uses Sass, Autoprefixer, and terser.
npm testRuns tests locally after running npm run dist
npm run docs-serveBuilds and runs the documentation locally.
+ +
+Get started with Bootstrap via npm with our starter project! Head to the twbs/bootstrap-npm-starter template repository to see how to build and customize Bootstrap in your own npm project. Includes Sass compiler, Autoprefixer, Stylelint, PurgeCSS, and Bootstrap Icons. +
+ +

Sass

+

Bootstrap uses Dart Sass for compiling our Sass source files into CSS files (included in our build process), and we recommend you do the same if you’re compiling Sass using your own asset pipeline. We previously used Node Sass for Bootstrap v4, but LibSass and packages built on top of it, including Node Sass, are now deprecated.

+

Dart Sass uses a rounding precision of 10 and for efficiency reasons does not allow adjustment of this value. We don’t lower this precision during further processing of our generated CSS, such as during minification, but if you chose to do so we recommend maintaining a precision of at least 6 to prevent issues with browser rounding.

+

Autoprefixer

+

Bootstrap uses Autoprefixer (included in our build process) to automatically add vendor prefixes to some CSS properties at build time. Doing so saves us time and code by allowing us to write key parts of our CSS a single time while eliminating the need for vendor mixins like those found in v3.

+

We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See .browserslistrc for details.

+

RTLCSS

+

Bootstrap uses RTLCSS to process compiled CSS and convert them to RTL – basically replacing horizontal direction aware properties (e.g. padding-left) with their opposite. It allows us only write our CSS a single time and make minor tweaks using RTLCSS control and value directives.

+

Local documentation

+

Running our documentation locally requires the use of Hugo, which gets installed via the hugo-bin npm package. Hugo is a blazingly fast and quite extensible static site generator that provides us: basic includes, Markdown-based files, templates, and more. Here’s how to get it started:

+
    +
  1. Run through the tooling setup above to install all dependencies.
    2. +
  2. From the root /bootstrap directory, run npm run docs-serve in the command line.
    3. +
  3. Open http://localhost:9001/ in your browser, and voilà.
    4. +
+

Learn more about using Hugo by reading its documentation.

+

Troubleshooting

+

Should you encounter problems with installing dependencies, uninstall all previous dependency versions (global and local). Then, rerun npm install.

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/download/index.html b/docs/5.3/getting-started/download/index.html new file mode 100644 index 0000000000..c53082c4c4 --- /dev/null +++ b/docs/5.3/getting-started/download/index.html @@ -0,0 +1,760 @@ + + + + + + + + + + + + +Download · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Download

+
+

Download Bootstrap to get the compiled CSS and JavaScript, source code, or include it with your favorite package managers like npm, RubyGems, and more.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Compiled CSS and JS

+

Download ready-to-use compiled code for Bootstrap v5.3.0-alpha1 to easily drop into your project, which includes:

+ +

This doesn’t include documentation, source files, or any optional JavaScript dependencies like Popper.

+

Download

+

Source files

+

Compile Bootstrap with your own asset pipeline by downloading our source Sass, JavaScript, and documentation files. This option requires some additional tooling:

+ +

Should you require our full set of build tools, they are included for developing Bootstrap and its docs, but they’re likely unsuitable for your own purposes.

+

Download source

+

Examples

+

If you want to download and examine our examples, you can grab the already built examples:

+

Download Examples

+

CDN via jsDelivr

+

Skip the download with jsDelivr to deliver cached version of Bootstrap’s compiled CSS and JS to your project.

+
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-GLhlTQ8iRABdZLl6O3oVMWSktQOp6b7In1Zl3/Jr59b6EGGoI1aFkw7cmDA6j6gD" crossorigin="anonymous">
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.bundle.min.js" integrity="sha384-w76AqPfDkMBDXo30jS1Sgez6pr3x5MlQ1ZAGC+nuZB+EYdgRZgiwxhTBTkF7CXvN" crossorigin="anonymous"></script>
+

If you’re using our compiled JavaScript and prefer to include Popper separately, add Popper before our JS, via a CDN preferably.

+
<script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.6/dist/umd/popper.min.js" integrity="sha384-oBqDVmMz9ATKxIep9tiCxS/Z9fNfEXiDAYTujMAeBAsjFuCZSmKbSSUnQlmh/jp3" crossorigin="anonymous"></script>
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.min.js" integrity="sha384-mQ93GR66B00ZXjt0YO5KlohRA5SY2XofN4zfuZxLkoj1gXtW8ANNCe9d5Y3eG5eD" crossorigin="anonymous"></script>
+

Package managers

+

Pull in Bootstrap’s source files into nearly any project with some of the most popular package managers. No matter the package manager, Bootstrap will require a Sass compiler and Autoprefixer for a setup that matches our official compiled versions.

+

npm

+

Install Bootstrap in your Node.js powered apps with the npm package:

+
npm install bootstrap@5.3.0-alpha1
+

const bootstrap = require('bootstrap') or import bootstrap from 'bootstrap' will load all of Bootstrap’s plugins onto a bootstrap object. +The bootstrap module itself exports all of our plugins. You can manually load Bootstrap’s plugins individually by loading the /js/dist/*.js files under the package’s top-level directory.

+

Bootstrap’s package.json contains some additional metadata under the following keys:

+
    +
  • sass - path to Bootstrap’s main Sass source file
    • +
  • style - path to Bootstrap’s non-minified CSS that’s been compiled using the default settings (no customization)
    • +
+
+Get started with Bootstrap via npm with our starter project! Head to the twbs/bootstrap-npm-starter template repository to see how to build and customize Bootstrap in your own npm project. Includes Sass compiler, Autoprefixer, Stylelint, PurgeCSS, and Bootstrap Icons. +
+ +

yarn

+

Install Bootstrap in your Node.js powered apps with the yarn package:

+
yarn add bootstrap@5.3.0-alpha1
+

RubyGems

+

Install Bootstrap in your Ruby apps using Bundler (recommended) and RubyGems by adding the following line to your Gemfile:

+
gem 'bootstrap', '~> 5.3.0-alpha1'
+

Alternatively, if you’re not using Bundler, you can install the gem by running this command:

+
gem install bootstrap -v 5.3.0-alpha1
+

See the gem’s README for further details.

+

Composer

+

You can also install and manage Bootstrap’s Sass and JavaScript using Composer:

+
composer require twbs/bootstrap:5.3.0-alpha1
+

NuGet

+

If you develop in .NET Framework, you can also install and manage Bootstrap’s CSS or Sass and JavaScript using NuGet. Newer projects should use libman or another method as NuGet is designed for compiled code, not frontend assets.

+
Install-Package bootstrap
+
Install-Package bootstrap.sass
+
+
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/index.html b/docs/5.3/getting-started/index.html new file mode 100644 index 0000000000..349df656a8 --- /dev/null +++ b/docs/5.3/getting-started/index.html @@ -0,0 +1,12 @@ + + + + + + https://getbootstrap.com/docs/5.3/getting-started/introduction/ + + + + + + diff --git a/docs/5.3/getting-started/introduction/index.html b/docs/5.3/getting-started/introduction/index.html new file mode 100644 index 0000000000..5fd5e9f908 --- /dev/null +++ b/docs/5.3/getting-started/introduction/index.html @@ -0,0 +1,832 @@ + + + + + + + + + + + + +Get started with Bootstrap · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Get started with Bootstrap

+
+

Bootstrap is a powerful, feature-packed frontend toolkit. Build anything—from prototype to production—in minutes.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Quick start

+

Get started by including Bootstrap’s production-ready CSS and JavaScript via CDN without the need for any build steps. See it in practice with this Bootstrap CodePen demo.

+
+
    +
  1. +

    Create a new index.html file in your project root. Include the <meta name="viewport"> tag as well for proper responsive behavior in mobile devices.

    +
    <!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Bootstrap demo</title>
+  </head>
+  <body>
+    <h1>Hello, world!</h1>
+  </body>
+</html>
+
    2. +
  2. +

    Include Bootstrap’s CSS and JS. Place the <link> tag in the <head> for our CSS, and the <script> tag for our JavaScript bundle (including Popper for positioning dropdowns, poppers, and tooltips) before the closing </body>. Learn more about our CDN links.

    +
    <!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Bootstrap demo</title>
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-GLhlTQ8iRABdZLl6O3oVMWSktQOp6b7In1Zl3/Jr59b6EGGoI1aFkw7cmDA6j6gD" crossorigin="anonymous">
+  </head>
+  <body>
+    <h1>Hello, world!</h1>
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.bundle.min.js" integrity="sha384-w76AqPfDkMBDXo30jS1Sgez6pr3x5MlQ1ZAGC+nuZB+EYdgRZgiwxhTBTkF7CXvN" crossorigin="anonymous"></script>
+  </body>
+</html>
+

    You can also include Popper and our JS separately. If you don’t plan to use dropdowns, popovers, or tooltips, save some kilobytes by not including Popper.

    +
    <script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.6/dist/umd/popper.min.js" integrity="sha384-oBqDVmMz9ATKxIep9tiCxS/Z9fNfEXiDAYTujMAeBAsjFuCZSmKbSSUnQlmh/jp3" crossorigin="anonymous"></script>
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.min.js" integrity="sha384-mQ93GR66B00ZXjt0YO5KlohRA5SY2XofN4zfuZxLkoj1gXtW8ANNCe9d5Y3eG5eD" crossorigin="anonymous"></script>
+
    3. +
  3. +

    Hello, world! Open the page in your browser of choice to see your Bootstrapped page. Now you can start building with Bootstrap by creating your own layout, adding dozens of components, and utilizing our official examples.

    +
    4. +
+ +

As reference, here are our primary CDN links.

+
+ + + + + + + + + + + + + + + + +
DescriptionURL
CSShttps://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/css/bootstrap.min.css
JShttps://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.bundle.min.js
+ +

You can also use the CDN to fetch any of our additional builds listed in the Contents page.

+

Next steps

+ +

JS components

+

Curious which components explicitly require our JavaScript and Popper? Click the show components link below. If you’re at all unsure about the general page structure, keep reading for an example page template.

+
+Show components requiring JavaScript +
    +
  • Alerts for dismissing
    • +
  • Buttons for toggling states and checkbox/radio functionality
    • +
  • Carousel for all slide behaviors, controls, and indicators
    • +
  • Collapse for toggling visibility of content
    • +
  • Dropdowns for displaying and positioning (also requires Popper)
    • +
  • Modals for displaying, positioning, and scroll behavior
    • +
  • Navbar for extending our Collapse and Offcanvas plugins to implement responsive behaviors
    • +
  • Navs with the Tab plugin for toggling content panes
    • +
  • Offcanvases for displaying, positioning, and scroll behavior
    • +
  • Scrollspy for scroll behavior and navigation updates
    • +
  • Toasts for displaying and dismissing
    • +
  • Tooltips and popovers for displaying and positioning (also requires Popper)
    • +
+ +
+

Important globals

+

Bootstrap employs a handful of important global styles and settings, all of which are almost exclusively geared towards the normalization of cross browser styles. Let’s dive in.

+

HTML5 doctype

+

Bootstrap requires the use of the HTML5 doctype. Without it, you’ll see some funky and incomplete styling.

+
<!doctype html>
+<html lang="en">
+  ...
+</html>
+

Responsive meta tag

+

Bootstrap is developed mobile first, a strategy in which we optimize code for mobile devices first and then scale up components as necessary using CSS media queries. To ensure proper rendering and touch zooming for all devices, add the responsive viewport meta tag to your <head>.

+
<meta name="viewport" content="width=device-width, initial-scale=1">
+

You can see an example of this in action in the quick start.

+

Box-sizing

+

For more straightforward sizing in CSS, we switch the global box-sizing value from content-box to border-box. This ensures padding does not affect the final computed width of an element, but it can cause problems with some third-party software like Google Maps and Google Custom Search Engine.

+

On the rare occasion you need to override it, use something like the following:

+
.selector-for-some-widget {
+  box-sizing: content-box;
+}
+

With the above snippet, nested elements—including generated content via ::before and ::after—will all inherit the specified box-sizing for that .selector-for-some-widget.

+

Learn more about box model and sizing at CSS Tricks.

+

Reboot

+

For improved cross-browser rendering, we use Reboot to correct inconsistencies across browsers and devices while providing slightly more opinionated resets to common HTML elements.

+

Community

+

Stay up-to-date on the development of Bootstrap and reach out to the community with these helpful resources.

+
    +
  • Read and subscribe to The Official Bootstrap Blog.
    • +
  • Ask and explore our GitHub Discussions.
    • +
  • Chat with fellow Bootstrappers in IRC. On the irc.libera.chat server, in the #bootstrap channel.
    • +
  • Implementation help may be found at Stack Overflow (tagged bootstrap-5).
    • +
  • Developers should use the keyword bootstrap on packages that modify or add to the functionality of Bootstrap when distributing through npm or similar delivery mechanisms for maximum discoverability.
    • +
+

You can also follow @getbootstrap on Twitter for the latest gossip and awesome music videos.

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/javascript/index.html b/docs/5.3/getting-started/javascript/index.html new file mode 100644 index 0000000000..ed409b014f --- /dev/null +++ b/docs/5.3/getting-started/javascript/index.html @@ -0,0 +1,968 @@ + + + + + + + + + + + + +JavaScript · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

JavaScript

+
+

Bring Bootstrap to life with our optional JavaScript plugins. Learn about each plugin, our data and programmatic API options, and more.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Individual or compiled

+

Plugins can be included individually (using Bootstrap’s individual js/dist/*.js), or all at once using bootstrap.js or the minified bootstrap.min.js (don’t include both).

+

If you use a bundler (Webpack, Parcel, Vite…), you can use /js/dist/*.js files which are UMD ready.

+

Usage with JavaScript frameworks

+

While the Bootstrap CSS can be used with any framework, the Bootstrap JavaScript is not fully compatible with JavaScript frameworks like React, Vue, and Angular which assume full knowledge of the DOM. Both Bootstrap and the framework may attempt to mutate the same DOM element, resulting in bugs like dropdowns that are stuck in the “open” position.

+

A better alternative for those using this type of frameworks is to use a framework-specific package instead of the Bootstrap JavaScript. Here are some of the most popular options:

+ +

Using Bootstrap as a module

+
+Try it yourself! Download the source code and working demo for using Bootstrap as an ES module from the twbs/examples repository. You can also open the example in StackBlitz. +
+ +

We provide a version of Bootstrap built as ESM (bootstrap.esm.js and bootstrap.esm.min.js) which allows you to use Bootstrap as a module in the browser, if your targeted browsers support it.

+
<script type="module">
+  import { Toast } from 'bootstrap.esm.min.js'
+
+  Array.from(document.querySelectorAll('.toast'))
+    .forEach(toastNode => new Toast(toastNode))
+</script>
+

Compared to JS bundlers, using ESM in the browser requires you to use the full path and filename instead of the module name. Read more about JS modules in the browser. That’s why we use 'bootstrap.esm.min.js' instead of 'bootstrap' above. However, this is further complicated by our Popper dependency, which imports Popper into our JavaScript like so:

+ +
import * as Popper from "@popperjs/core"
+

If you try this as-is, you’ll see an error in the console like the following:

+
Uncaught TypeError: Failed to resolve module specifier "@popperjs/core". Relative references must start with either "/", "./", or "../".
+

To fix this, you can use an importmap to resolve the arbitrary module names to complete paths. If your targeted browsers do not support importmap, you’ll need to use the es-module-shims project. Here’s how it works for Bootstrap and Popper:

+
<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-GLhlTQ8iRABdZLl6O3oVMWSktQOp6b7In1Zl3/Jr59b6EGGoI1aFkw7cmDA6j6gD" crossorigin="anonymous">
+    <title>Hello, modularity!</title>
+  </head>
+  <body>
+    <h1>Hello, modularity!</h1>
+    <button id="popoverButton" type="button" class="btn btn-primary btn-lg" class="btn btn-lg btn-danger" data-bs-toggle="popover" title="ESM in Browser" data-bs-content="Bang!">Custom popover</button>
+
+    <script async src="https://cdn.jsdelivr.net/npm/es-module-shims@1/dist/es-module-shims.min.js" crossorigin="anonymous"></script>
+    <script type="importmap">
+    {
+      "imports": {
+        "@popperjs/core": "https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.6/dist/umd/popper.min.js",
+        "bootstrap": "https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.esm.min.js"
+      }
+    }
+    </script>
+    <script type="module">
+      import * as bootstrap from 'bootstrap'
+
+      new bootstrap.Popover(document.getElementById('popoverButton'))
+    </script>
+  </body>
+</html>
+

Dependencies

+

Some plugins and CSS components depend on other plugins. If you include plugins individually, make sure to check for these dependencies in the docs.

+

Our dropdowns, popovers, and tooltips also depend on Popper.

+

Data attributes

+

Nearly all Bootstrap plugins can be enabled and configured through HTML alone with data attributes (our preferred way of using JavaScript functionality). Be sure to only use one set of data attributes on a single element (e.g., you cannot trigger a tooltip and modal from the same button.)

+

As options can be passed via data attributes or JavaScript, you can append an option name to data-bs-, as in data-bs-animation="{value}". Make sure to change the case type of the option name from “camelCase” to “kebab-case” when passing the options via data attributes. For example, use data-bs-custom-class="beautifier" instead of data-bs-customClass="beautifier".

+

As of Bootstrap 5.2.0, all components support an experimental reserved data attribute data-bs-config that can house simple component configuration as a JSON string. When an element has data-bs-config='{"delay":0, "title":123}' and data-bs-title="456" attributes, the final title value will be 456 and the separate data attributes will override values given on data-bs-config. In addition, existing data attributes are able to house JSON values like data-bs-delay='{"show":0,"hide":150}'.

+ +

Selectors

+

We use the native querySelector and querySelectorAll methods to query DOM elements for performance reasons, so you must use valid selectors. If you use special selectors like collapse:Example, be sure to escape them.

+

Events

+

Bootstrap provides custom events for most plugins’ unique actions. Generally, these come in an infinitive and past participle form - where the infinitive (ex. show) is triggered at the start of an event, and its past participle form (ex. shown) is triggered on the completion of an action.

+

All infinitive events provide preventDefault() functionality. This provides the ability to stop the execution of an action before it starts. Returning false from an event handler will also automatically call preventDefault().

+
const myModal = document.querySelector('#myModal')
+
+myModal.addEventListener('show.bs.modal', event => {
+  if (!data) {
+    return event.preventDefault() // stops modal from being shown
+  }
+})
+

Programmatic API

+

All constructors accept an optional options object or nothing (which initiates a plugin with its default behavior):

+
const myModalEl = document.querySelector('#myModal')
+const modal = new bootstrap.Modal(myModalEl) // initialized with defaults
+
+const configObject = { keyboard: false }
+const modal1 = new bootstrap.Modal(myModalEl, configObject) // initialized with no keyboard
+

If you’d like to get a particular plugin instance, each plugin exposes a getInstance method. For example, to retrieve an instance directly from an element:

+
bootstrap.Popover.getInstance(myPopoverEl)
+

This method will return null if an instance is not initiated over the requested element.

+

Alternatively, getOrCreateInstance can be used to get the instance associated with a DOM element, or create a new one in case it wasn’t initialized.

+
bootstrap.Popover.getOrCreateInstance(myPopoverEl, configObject)
+

In case an instance wasn’t initialized, it may accept and use an optional configuration object as second argument.

+

CSS selectors in constructors

+

In addition to the getInstance and getOrCreateInstance methods, all plugin constructors can accept a DOM element or a valid CSS selector as the first argument. Plugin elements are found with the querySelector method since our plugins only support a single element.

+
const modal = new bootstrap.Modal('#myModal')
+const dropdown = new bootstrap.Dropdown('[data-bs-toggle="dropdown"]')
+const offcanvas = bootstrap.Offcanvas.getInstance('#myOffcanvas')
+const alert = bootstrap.Alert.getOrCreateInstance('#myAlert')
+

Asynchronous functions and transitions

+

All programmatic API methods are asynchronous and return to the caller once the transition is started, but before it ends. In order to execute an action once the transition is complete, you can listen to the corresponding event.

+
const myCollapseEl = document.querySelector('#myCollapse')
+
+myCollapseEl.addEventListener('shown.bs.collapse', event => {
+  // Action to execute once the collapsible area is expanded
+})
+

In addition, a method call on a transitioning component will be ignored.

+
const myCarouselEl = document.querySelector('#myCarousel')
+const carousel = bootstrap.Carousel.getInstance(myCarouselEl) // Retrieve a Carousel instance
+
+myCarouselEl.addEventListener('slid.bs.carousel', event => {
+  carousel.to('2') // Will slide to the slide 2 as soon as the transition to slide 1 is finished
+})
+
+carousel.to('1') // Will start sliding to the slide 1 and returns to the caller
+carousel.to('2') // !! Will be ignored, as the transition to the slide 1 is not finished !!
+

dispose method

+

While it may seem correct to use the dispose method immediately after hide(), it will lead to incorrect results. Here’s an example of the problem use:

+
const myModal = document.querySelector('#myModal')
+myModal.hide() // it is asynchronous
+
+myModal.addEventListener('shown.bs.hidden', event => {
+  myModal.dispose()
+})
+

Default settings

+

You can change the default settings for a plugin by modifying the plugin’s Constructor.Default object:

+
// changes default for the modal plugin's `keyboard` option to false
+bootstrap.Modal.Default.keyboard = false
+

Methods and properties

+

Every Bootstrap plugin exposes the following methods and static properties.

+
+ + + + + + + + + + + + + + + + + + + + +
MethodDescription
disposeDestroys an element’s modal. (Removes stored data on the DOM element)
getInstanceStatic method which allows you to get the modal instance associated with a DOM element.
getOrCreateInstanceStatic method which allows you to get the modal instance associated with a DOM element, or create a new one in case it wasn’t initialized.
+ +
+ + + + + + + + + + + + + + + + +
Static propertyDescription
NAMEReturns the plugin name. (Example: bootstrap.Tooltip.NAME)
VERSIONThe version of each of Bootstrap’s plugins can be accessed via the VERSION property of the plugin’s constructor (Example: bootstrap.Tooltip.VERSION)
+ +

Sanitizer

+

Tooltips and Popovers use our built-in sanitizer to sanitize options which accept HTML.

+

The default allowList value is the following:

+
const ARIA_ATTRIBUTE_PATTERN = /^aria-[\w-]*$/i
+const DefaultAllowlist = {
+  // Global attributes allowed on any supplied element below.
+  '*': ['class', 'dir', 'id', 'lang', 'role', ARIA_ATTRIBUTE_PATTERN],
+  a: ['target', 'href', 'title', 'rel'],
+  area: [],
+  b: [],
+  br: [],
+  col: [],
+  code: [],
+  div: [],
+  em: [],
+  hr: [],
+  h1: [],
+  h2: [],
+  h3: [],
+  h4: [],
+  h5: [],
+  h6: [],
+  i: [],
+  img: ['src', 'srcset', 'alt', 'title', 'width', 'height'],
+  li: [],
+  ol: [],
+  p: [],
+  pre: [],
+  s: [],
+  small: [],
+  span: [],
+  sub: [],
+  sup: [],
+  strong: [],
+  u: [],
+  ul: []
+}
+

If you want to add new values to this default allowList you can do the following:

+
const myDefaultAllowList = bootstrap.Tooltip.Default.allowList
+
+// To allow table elements
+myDefaultAllowList.table = []
+
+// To allow td elements and data-bs-option attributes on td elements
+myDefaultAllowList.td = ['data-bs-option']
+
+// You can push your custom regex to validate your attributes.
+// Be careful about your regular expressions being too lax
+const myCustomRegex = /^data-my-app-[\w-]+/
+myDefaultAllowList['*'].push(myCustomRegex)
+

If you want to bypass our sanitizer because you prefer to use a dedicated library, for example DOMPurify, you should do the following:

+
const yourTooltipEl = document.querySelector('#yourTooltip')
+const tooltip = new bootstrap.Tooltip(yourTooltipEl, {
+  sanitizeFn(content) {
+    return DOMPurify.sanitize(content)
+  }
+})
+

Optionally using jQuery

+

You don’t need jQuery in Bootstrap 5, but it’s still possible to use our components with jQuery. If Bootstrap detects jQuery in the window object, it’ll add all of our components in jQuery’s plugin system. This allows you to do the following:

+
// to enable tooltips with the default configuration
+$('[data-bs-toggle="tooltip"]').tooltip()
+
+// to initialize tooltips with given configuration
+$('[data-bs-toggle="tooltip"]').tooltip({
+  boundary: 'clippingParents',
+  customClass: 'myClass'
+})
+
+// to trigger the `show` method
+$('#myTooltip').tooltip('show')
+

The same goes for our other components.

+

No conflict

+

Sometimes it is necessary to use Bootstrap plugins with other UI frameworks. In these circumstances, namespace collisions can occasionally occur. If this happens, you may call .noConflict on the plugin you wish to revert the value of.

+
const bootstrapButton = $.fn.button.noConflict() // return $.fn.button to previously assigned value
+$.fn.bootstrapBtn = bootstrapButton // give $().bootstrapBtn the Bootstrap functionality
+

Bootstrap does not officially support third-party JavaScript libraries like Prototype or jQuery UI. Despite .noConflict and namespaced events, there may be compatibility problems that you need to fix on your own.

+

jQuery events

+

Bootstrap will detect jQuery if jQuery is present in the window object and there is no data-bs-no-jquery attribute set on <body>. If jQuery is found, Bootstrap will emit events thanks to jQuery’s event system. So if you want to listen to Bootstrap’s events, you’ll have to use the jQuery methods (.on, .one) instead of addEventListener.

+
$('#myTab a').on('shown.bs.tab', () => {
+  // do something...
+})
+

Disabled JavaScript

+

Bootstrap’s plugins have no special fallback when JavaScript is disabled. If you care about the user experience in this case, use <noscript> to explain the situation (and how to re-enable JavaScript) to your users, and/or add your own custom fallbacks.

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/parcel/index.html b/docs/5.3/getting-started/parcel/index.html new file mode 100644 index 0000000000..1497022a5f --- /dev/null +++ b/docs/5.3/getting-started/parcel/index.html @@ -0,0 +1,803 @@ + + + + + + + + + + + + +Bootstrap & Parcel · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Bootstrap & Parcel

+
+

The official guide for how to include and bundle Bootstrap’s CSS and JavaScript in your project using Parcel.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + + +
+Want to skip to the end? Download the source code and working demo for this guide from the twbs/examples repository. You can also open the example in StackBlitz but not run it because Parcel isn’t currently supported there. +
+ +

Setup

+

We’re building a Parcel project with Bootstrap from scratch, so there are some prerequisites and up front steps before we can really get started. This guide requires you to have Node.js installed and some familiarity with the terminal.

+
    +
  1. +

    Create a project folder and setup npm. We’ll create the my-project folder and initialize npm with the -y argument to avoid it asking us all the interactive questions.

    +
    mkdir my-project && cd my-project
+npm init -y
+
    2. +
  2. +

    Install Parcel. Unlike our Webpack guide, there’s only a single build tool dependency here. Parcel will automatically install language transformers (like Sass) as it detects them. We use --save-dev to signal that this dependency is only for development use and not for production.

    +
    npm i --save-dev parcel
+
    3. +
  3. +

    Install Bootstrap. Now we can install Bootstrap. We’ll also install Popper since our dropdowns, popovers, and tooltips depend on it for their positioning. If you don’t plan on using those components, you can omit Popper here.

    +
    npm i --save bootstrap @popperjs/core
+
    4. +
+

Now that we have all the necessary dependencies installed, we can get to work creating the project files and importing Bootstrap.

+

Project structure

+

We’ve already created the my-project folder and initialized npm. Now we’ll also create our src folder, stylesheet, and JavaScript file to round out the project structure. Run the following from my-project, or manually create the folder and file structure shown below.

+
mkdir {src,src/js,src/scss}
+touch src/index.html src/js/main.js src/scss/styles.scss
+

When you’re done, your complete project should look like this:

+
my-project/
+├── src/
+│   ├── js/
+│   │   └── main.js
+│   ├── scss/
+│   │   └── styles.scss
+│   └── index.html
+├── package-lock.json
+└── package.json
+

At this point, everything is in the right place, but Parcel needs an HTML page and npm script to start our server.

+

Configure Parcel

+

With dependencies installed and our project folder ready for us to start coding, we can now configure Parcel and run our project locally. Parcel itself requires no configuration file by design, but we do need an npm script and an HTML file to start our server.

+
    +
  1. +

    Fill in the src/index.html file. Parcel needs a page to render, so we use our index.html page to set up some basic HTML, including our CSS and JavaScript files.

    +
    <!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Bootstrap w/ Parcel</title>
+    <link rel="stylesheet" href="scss/styles.scss">
+    <script type="module" src="js/main.js"></script>
+  </head>
+  <body>
+    <div class="container py-4 px-3 mx-auto">
+      <h1>Hello, Bootstrap and Parcel!</h1>
+      <button class="btn btn-primary">Primary button</button>
+    </div>
+  </body>
+</html>
+

    We’re including a little bit of Bootstrap styling here with the div class="container" and <button> so that we see when Bootstrap’s CSS is loaded by Parcel.

    +

    Parcel will automatically detect we’re using Sass and install the Sass Parcel plugin to support it. However, if you wish, you can also manually run npm i --save-dev @parcel/transformer-sass.

    +
    2. +
  2. +

    Add the Parcel npm scripts. Open the package.json and add the following start script to the scripts object. We’ll use this script to start our Parcel development server and render the HTML file we created after it’s compiled into the dist directory.

    +
    {
+   // ...
+   "scripts": {
+     "start": "parcel serve src/index.html --public-url / --dist-dir dist",
+     "test": "echo \"Error: no test specified\" && exit 1"
+   },
+   // ...
+}
+
    3. +
  3. +

    And finally, we can start Parcel. From the my-project folder in your terminal, run that newly added npm script:

    +
    npm start
+
    Parcel dev server running +
    4. +
+

In the next and final section to this guide, we’ll import all of Bootstrap’s CSS and JavaScript.

+

Import Bootstrap

+

Importing Bootstrap into Parcel requires two imports, one into our styles.scss and one into our main.js.

+
    +
  1. +

    Import Bootstrap’s CSS. Add the following to src/scss/styles.scss to import all of Bootstrap’s source Sass.

    +
    // Import all of Bootstrap's CSS
+@import "~bootstrap/scss/bootstrap";
+

    You can also import our stylesheets individually if you want. Read our Sass import docs for details.

    +
    2. +
  2. +

    Import Bootstrap’s JS. Add the following to src/js/main.js to import all of Bootstrap’s JS. Popper will be imported automatically through Bootstrap.

    + +
    // Import all of Bootstrap's JS
+import * as bootstrap from 'bootstrap'
+

    You can also import JavaScript plugins individually as needed to keep bundle sizes down:

    + +
    import Alert from 'bootstrap/js/dist/alert'
+
+// or, specify which plugins you need:
+import { Tooltip, Toast, Popover } from 'bootstrap'
+

    Read our JavaScript docs for more information on how to use Bootstrap’s plugins.

    +
    3. +
  3. +

    And you’re done! 🎉 With Bootstrap’s source Sass and JS fully loaded, your local development server should now look like this.

    +Parcel dev server running with Bootstrap +

    Now you can start adding any Bootstrap components you want to use. Be sure to check out the complete Parcel example project for how to include additional custom Sass and optimize your build by importing only the parts of Bootstrap’s CSS and JS that you need.

    +
    4. +
+
+

See something wrong or out of date here? Please open an issue on GitHub. Need help troubleshooting? Search or start a discussion on GitHub. + +

+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/rfs/index.html b/docs/5.3/getting-started/rfs/index.html new file mode 100644 index 0000000000..b25ada590f --- /dev/null +++ b/docs/5.3/getting-started/rfs/index.html @@ -0,0 +1,745 @@ + + + + + + + + + + + + +RFS · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

RFS

+
+

Bootstrap’s resizing engine responsively scales common CSS properties to better utilize available space across viewports and devices.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

What is RFS?

+

Bootstrap’s side project RFS is a unit resizing engine which was initially developed to resize font sizes (hence its abbreviation for Responsive Font Sizes). Nowadays RFS is capable of rescaling most CSS properties with unit values like margin, padding, border-radius, or even box-shadow.

+

The mechanism automatically calculates the appropriate values based on the dimensions of the browser viewport. It will be compiled into calc() functions with a mix of rem and viewport units to enable the responsive scaling behavior.

+

Using RFS

+

The mixins are included in Bootstrap and are available once you include Bootstrap’s scss. RFS can also be installed standalone if needed.

+

Using the mixins

+

The rfs() mixin has shorthands for font-size, margin, margin-top, margin-right, margin-bottom, margin-left, padding, padding-top, padding-right, padding-bottom, and padding-left. See the example below for source Sass and compiled CSS.

+
.title {
+  @include font-size(4rem);
+}
+
.title {
+  font-size: calc(1.525rem + 3.3vw);
+}
+
+@media (min-width: 1200px) {
+  .title {
+    font-size: 4rem;
+  }
+}
+

Any other property can be passed to the rfs() mixin like this:

+
.selector {
+  @include rfs(4rem, border-radius);
+}
+

!important can also just be added to whatever value you want:

+
.selector {
+  @include padding(2.5rem !important);
+}
+

Using the functions

+

When you don’t want to use the includes, there are also two functions:

+
    +
  • rfs-value() converts a value into a rem value if a px value is passed, in other cases it returns the same result.
    • +
  • rfs-fluid-value() returns the fluid version of a value if the property needs rescaling.
    • +
+

In this example, we use one of Bootstrap’s built-in responsive breakpoint mixins to only apply styling below the lg breakpoint.

+
.selector {
+  @include media-breakpoint-down(lg) {
+    padding: rfs-fluid-value(2rem);
+    font-size: rfs-fluid-value(1.125rem);
+  }
+}
+
@media (max-width: 991.98px) {
+  .selector {
+    padding: calc(1.325rem + 0.9vw);
+    font-size: 1.125rem; /* 1.125rem is small enough, so RFS won't rescale this */
+  }
+}
+

Extended documentation

+

RFS is a separate project under the Bootstrap organization. More about RFS and its configuration can be found on its GitHub repository.

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/rtl/index.html b/docs/5.3/getting-started/rtl/index.html new file mode 100644 index 0000000000..df5179ef82 --- /dev/null +++ b/docs/5.3/getting-started/rtl/index.html @@ -0,0 +1,841 @@ + + + + + + + + + + + + +RTL · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

RTL

+
+

Learn how to enable support for right-to-left text in Bootstrap across our layout, components, and utilities.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Get familiar

+

We recommend getting familiar with Bootstrap first by reading through our Getting Started Introduction page. Once you’ve run through it, continue reading here for how to enable RTL.

+

You may also want to read up on the RTLCSS project, as it powers our approach to RTL.

+
+

Experimental feature

+

The RTL feature is still experimental and will probably evolve according to user feedback. Spotted something or have an improvement to suggest? Open an issue, we’d love to get your insights. +

+ +

Required HTML

+

There are two strict requirements for enabling RTL in Bootstrap-powered pages.

+
    +
  1. Set dir="rtl" on the <html> element.
    2. +
  2. Add an appropriate lang attribute, like lang="ar", on the <html> element.
    3. +
+

From there, you’ll need to include an RTL version of our CSS. For example, here’s the stylesheet for our compiled and minified CSS with RTL enabled:

+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/css/bootstrap.rtl.min.css" integrity="sha384-WJUUqfoMmnfkBLne5uxXj+na/c7sesSJ32gI7GfCk4zO4GthUKhSEGyvQ839BC51" crossorigin="anonymous">
+

Starter template

+

You can see the above requirements reflected in this modified RTL starter template.

+
<!doctype html>
+<html lang="ar" dir="rtl">
+  <head>
+    <!-- Required meta tags -->
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <!-- Bootstrap CSS -->
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/css/bootstrap.rtl.min.css" integrity="sha384-WJUUqfoMmnfkBLne5uxXj+na/c7sesSJ32gI7GfCk4zO4GthUKhSEGyvQ839BC51" crossorigin="anonymous">
+
+    <title>مرحبًا بالعالم!</title>
+  </head>
+  <body>
+    <h1>مرحبًا بالعالم!</h1>
+
+    <!-- Optional JavaScript; choose one of the two! -->
+
+    <!-- Option 1: Bootstrap Bundle with Popper -->
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.bundle.min.js" integrity="sha384-w76AqPfDkMBDXo30jS1Sgez6pr3x5MlQ1ZAGC+nuZB+EYdgRZgiwxhTBTkF7CXvN" crossorigin="anonymous"></script>
+
+    <!-- Option 2: Separate Popper and Bootstrap JS -->
+    <!--
+    <script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.6/dist/umd/popper.min.js" integrity="sha384-oBqDVmMz9ATKxIep9tiCxS/Z9fNfEXiDAYTujMAeBAsjFuCZSmKbSSUnQlmh/jp3" crossorigin="anonymous"></script>
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.min.js" integrity="sha384-mQ93GR66B00ZXjt0YO5KlohRA5SY2XofN4zfuZxLkoj1gXtW8ANNCe9d5Y3eG5eD" crossorigin="anonymous"></script>
+    -->
+  </body>
+</html>
+

RTL examples

+

Get started with one of our several RTL examples.

+

Approach

+

Our approach to building RTL support into Bootstrap comes with two important decisions that impact how we write and use our CSS:

+
    +
  1. +

    First, we decided to build it with the RTLCSS project. This gives us some powerful features for managing changes and overrides when moving from LTR to RTL. It also allows us to build two versions of Bootstrap from one codebase.

    +
    2. +
  2. +

    Second, we’ve renamed a handful of directional classes to adopt a logical properties approach. Most of you have already interacted with logical properties thanks to our flex utilities—they replace direction properties like left and right in favor start and end. That makes the class names and values appropriate for LTR and RTL without any overhead.

    +
    3. +
+

For example, instead of .ml-3 for margin-left, use .ms-3.

+

Working with RTL, through our source Sass or compiled CSS, shouldn’t be much different from our default LTR though.

+

Customize from source

+

When it comes to customization, the preferred way is to take advantage of variables, maps, and mixins. This approach works the same for RTL, even if it’s post-processed from the compiled files, thanks to how RTLCSS works.

+

Custom RTL values

+

Using RTLCSS value directives, you can make a variable output a different value for RTL. For example, to decrease the weight for $font-weight-bold throughout the codebase, you may use the /*rtl: {value}*/ syntax:

+
$font-weight-bold: 700 #{/* rtl:600 */} !default;
+

Which would output to the following for our default CSS and RTL CSS:

+
/* bootstrap.css */
+dt {
+  font-weight: 700 /* rtl:600 */;
+}
+
+/* bootstrap.rtl.css */
+dt {
+  font-weight: 600;
+}
+

Alternative font stack

+

In the case you’re using a custom font, be aware that not all fonts support the non-Latin alphabet. To switch from Pan-European to Arabic family, you may need to use /*rtl:insert: {value}*/ in your font stack to modify the names of font families.

+

For example, to switch from Helvetica Neue font for LTR to Helvetica Neue Arabic for RTL, your Sass code could look like this:

+
$font-family-sans-serif:
+  Helvetica Neue #{"/* rtl:insert:Arabic */"},
+  // Cross-platform generic font family (default user interface font)
+  system-ui,
+  // Safari for macOS and iOS (San Francisco)
+  -apple-system,
+  // Chrome < 56 for macOS (San Francisco)
+  BlinkMacSystemFont,
+  // Windows
+  "Segoe UI",
+  // Android
+  Roboto,
+  // Basic web fallback
+  Arial,
+  // Linux
+  "Noto Sans",
+  // Sans serif fallback
+  sans-serif,
+  // Emoji fonts
+  "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji" !default;
+

LTR and RTL at the same time

+

Need both LTR and RTL on the same page? Thanks to RTLCSS String Maps, this is pretty straightforward. Wrap your @imports with a class, and set a custom rename rule for RTLCSS:

+
/* rtl:begin:options: {
+  "autoRename": true,
+  "stringMap":[ {
+    "name": "ltr-rtl",
+    "priority": 100,
+    "search": ["ltr"],
+    "replace": ["rtl"],
+    "options": {
+      "scope": "*",
+      "ignoreCase": false
+    }
+  } ]
+} */
+.ltr {
+  @import "../node_modules/bootstrap/scss/bootstrap";
+}
+/*rtl:end:options*/
+

After running Sass then RTLCSS, each selector in your CSS files will be prepended by .ltr, and .rtl for RTL files. Now you’re able to use both files on the same page, and simply use .ltr or .rtl on your components wrappers to use one or the other direction.

+
+

Edge cases and known limitations

+

While this approach is understandable, please pay attention to the following:

+
    +
  1. When switching .ltr and .rtl, make sure you add dir and lang attributes accordingly.
    2. +
  2. Loading both files can be a real performance bottleneck: consider some optimization, and maybe try to load one of those files asynchronously.
    3. +
  3. Nesting styles this way will prevent our form-validation-state() mixin from working as intended, thus require you tweak it a bit by yourself. See #31223.
    4. +
+ +
+ +

The breadcrumb case

+

The breadcrumb separator is the only case requiring its own brand-new variable— namely $breadcrumb-divider-flipped —defaulting to $breadcrumb-divider.

+

Additional resources

+ + +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/vite/index.html b/docs/5.3/getting-started/vite/index.html new file mode 100644 index 0000000000..1ea35bdc62 --- /dev/null +++ b/docs/5.3/getting-started/vite/index.html @@ -0,0 +1,839 @@ + + + + + + + + + + + + +Bootstrap & Vite · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Bootstrap & Vite

+
+

The official guide for how to include and bundle Bootstrap’s CSS and JavaScript in your project using Vite.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + + +
+Want to skip to the end? Download the source code and working demo for this guide from the twbs/examples repository. You can also open the example in StackBlitz for live editing. +
+ +

Setup

+

We’re building a Vite project with Bootstrap from scratch, so there are some prerequisites and up front steps before we can really get started. This guide requires you to have Node.js installed and some familiarity with the terminal.

+
    +
  1. +

    Create a project folder and setup npm. We’ll create the my-project folder and initialize npm with the -y argument to avoid it asking us all the interactive questions.

    +
    mkdir my-project && cd my-project
+npm init -y
+
    2. +
  2. +

    Install Vite. Unlike our Webpack guide, there’s only a single build tool dependency here. We use --save-dev to signal that this dependency is only for development use and not for production.

    +
    npm i --save-dev vite
+
    3. +
  3. +

    Install Bootstrap. Now we can install Bootstrap. We’ll also install Popper since our dropdowns, popovers, and tooltips depend on it for their positioning. If you don’t plan on using those components, you can omit Popper here.

    +
    npm i --save bootstrap @popperjs/core
+
    4. +
  4. +

    Install additional dependency. In addition to Vite and Bootstrap, we need another dependency (Sass) to properly import and bundle Bootstrap’s CSS.

    +
    npm i --save-dev sass
+
    5. +
+

Now that we have all the necessary dependencies installed and setup, we can get to work creating the project files and importing Bootstrap.

+

Project structure

+

We’ve already created the my-project folder and initialized npm. Now we’ll also create our src folder, stylesheet, and JavaScript file to round out the project structure. Run the following from my-project, or manually create the folder and file structure shown below.

+
mkdir {src,src/js,src/scss}
+touch src/index.html src/js/main.js src/scss/styles.scss vite.config.js
+

When you’re done, your complete project should look like this:

+
my-project/
+├── src/
+│   ├── js/
+│   │   └── main.js
+│   └── scss/
+│   |   └── styles.scss
+|   └── index.html
+├── package-lock.json
+├── package.json
+└── vite.config.js
+

At this point, everything is in the right place, but Vite won’t work because we haven’t filled in our vite.config.js yet.

+

Configure Vite

+

With dependencies installed and our project folder ready for us to start coding, we can now configure Vite and run our project locally.

+
    +
  1. +

    Open vite.config.js in your editor. Since it’s blank, we’ll need to add some boilerplate config to it so we can start our server. This part of the config tells Vite where to look for our project’s JavaScript and how the development server should behave (pulling from the src folder with hot reload).

    + +
    const path = require('path')
+
+export default {
+  root: path.resolve(__dirname, 'src'),
+  server: {
+    port: 8080,
+    hot: true
+  }
+}
+
    2. +
  2. +

    Next we fill in src/index.html. This is the HTML page Vite will load in the browser to utilize the bundled CSS and JS we’ll add to it in later steps.

    +
    <!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Bootstrap w/ Vite</title>
+  </head>
+  <body>
+    <div class="container py-4 px-3 mx-auto">
+      <h1>Hello, Bootstrap and Vite!</h1>
+      <button class="btn btn-primary">Primary button</button>
+    </div>
+    <script type="module" src="./js/main.js"></script>
+  </body>
+</html>
+

    We’re including a little bit of Bootstrap styling here with the div class="container" and <button> so that we see when Bootstrap’s CSS is loaded by Vite.

    +
    3. +
  3. +

    Now we need an npm script to run Vite. Open package.json and add the start script shown below (you should already have the test script). We’ll use this script to start our local Vite dev server.

    +
    {
+  // ...
+  "scripts": {
+    "start": "vite",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  // ...
+}
+
    4. +
  4. +

    And finally, we can start Vite. From the my-project folder in your terminal, run that newly added npm script:

    +
    npm start
+
    Vite dev server running +
    5. +
+

In the next and final section to this guide, we’ll import all of Bootstrap’s CSS and JavaScript.

+

Import Bootstrap

+
    +
  1. +

    Set up Bootstrap’s Sass import in vite.config.js. Your configuration file is now complete and should match the snippet below. The only new part here is the resolve section—we use this to add an alias to our source files inside node_modules to keep imports as simple as possible.

    + +
    const path = require('path')
+
+export default {
+  root: path.resolve(__dirname, 'src'),
+  resolve: {
+    alias: {
+      '~bootstrap': path.resolve(__dirname, 'node_modules/bootstrap'),
+    }
+  },
+  server: {
+    port: 8080,
+    hot: true
+  }
+}
+
    2. +
  2. +

    Now, let’s import Bootstrap’s CSS. Add the following to src/scss/styles.scss to import all of Bootstrap’s source Sass.

    +
    // Import all of Bootstrap's CSS
+@import "~bootstrap/scss/bootstrap";
+

    You can also import our stylesheets individually if you want. Read our Sass import docs for details.

    +
    3. +
  3. +

    Next we load the CSS and import Bootstrap’s JavaScript. Add the following to src/js/main.js to load the CSS and import all of Bootstrap’s JS. Popper will be imported automatically through Bootstrap.

    + +
    // Import our custom CSS
+import '../scss/styles.scss'
+
+// Import all of Bootstrap's JS
+import * as bootstrap from 'bootstrap'
+

    You can also import JavaScript plugins individually as needed to keep bundle sizes down:

    + +
    import Alert from 'bootstrap/js/dist/alert';
+
+// or, specify which plugins you need:
+import { Tooltip, Toast, Popover } from 'bootstrap';
+

    Read our JavaScript docs for more information on how to use Bootstrap’s plugins.

    +
    4. +
  4. +

    And you’re done! 🎉 With Bootstrap’s source Sass and JS fully loaded, your local development server should now look like this.

    +Vite dev server running with Bootstrap +

    Now you can start adding any Bootstrap components you want to use. Be sure to check out the complete Vite example project for how to include additional custom Sass and optimize your build by importing only the parts of Bootstrap’s CSS and JS that you need.

    +
    5. +
+
+

See something wrong or out of date here? Please open an issue on GitHub. Need help troubleshooting? Search or start a discussion on GitHub. + +

+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/getting-started/webpack/index.html b/docs/5.3/getting-started/webpack/index.html new file mode 100644 index 0000000000..8cee36d717 --- /dev/null +++ b/docs/5.3/getting-started/webpack/index.html @@ -0,0 +1,942 @@ + + + + + + + + + + + + +Bootstrap & Webpack · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Bootstrap & Webpack

+
+

The official guide for how to include and bundle Bootstrap’s CSS and JavaScript in your project using Webpack.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + + +
+Want to skip to the end? Download the source code and working demo for this guide from the twbs/examples repository. You can also open the example in StackBlitz for live editing. +
+ +

Setup

+

We’re building a Webpack project with Bootstrap from scratch, so there are some prerequisites and up front steps before we can really get started. This guide requires you to have Node.js installed and some familiarity with the terminal.

+
    +
  1. +

    Create a project folder and setup npm. We’ll create the my-project folder and initialize npm with the -y argument to avoid it asking us all the interactive questions.

    +
    mkdir my-project && cd my-project
+npm init -y
+
    2. +
  2. +

    Install Webpack. Next we need to install our Webpack development dependencies: webpack for the core of Webpack, webpack-cli so we can run Webpack commands from the terminal, and webpack-dev-server so we can run a local development server. We use --save-dev to signal that these dependencies are only for development use and not for production.

    +
    npm i --save-dev webpack webpack-cli webpack-dev-server
+
    3. +
  3. +

    Install Bootstrap. Now we can install Bootstrap. We’ll also install Popper since our dropdowns, popovers, and tooltips depend on it for their positioning. If you don’t plan on using those components, you can omit Popper here.

    +
    npm i --save bootstrap @popperjs/core
+
    4. +
  4. +

    Install additional dependencies. In addition to Webpack and Bootstrap, we need a few more dependencies to properly import and bundle Bootstrap’s CSS and JS with Webpack. These include Sass, some loaders, and Autoprefixer.

    +
    npm i --save-dev autoprefixer css-loader postcss-loader sass sass-loader style-loader
+
    5. +
+

Now that we have all the necessary dependencies installed, we can get to work creating the project files and importing Bootstrap.

+

Project structure

+

We’ve already created the my-project folder and initialized npm. Now we’ll also create our src and dist folders to round out the project structure. Run the following from my-project, or manually create the folder and file structure shown below.

+
mkdir {dist,src,src/js,src/scss}
+touch dist/index.html src/js/main.js src/scss/styles.scss webpack.config.js
+

When you’re done, your complete project should look like this:

+
my-project/
+├── dist/
+│   └── index.html
+├── src/
+│   ├── js/
+│   │   └── main.js
+│   └── scss/
+│       └── styles.scss
+├── package-lock.json
+├── package.json
+└── webpack.config.js
+

At this point, everything is in the right place, but Webpack won’t work because we haven’t filled in our webpack.config.js yet.

+

Configure Webpack

+

With dependencies installed and our project folder ready for us to start coding, we can now configure Webpack and run our project locally.

+
    +
  1. +

    Open webpack.config.js in your editor. Since it’s blank, we’ll need to add some boilerplate config to it so we can start our server. This part of the config tells Webpack where to look for our project’s JavaScript, where to output the compiled code to (dist), and how the development server should behave (pulling from the dist folder with hot reload).

    +
    const path = require('path')
+
+module.exports = {
+  entry: './src/js/main.js',
+  output: {
+    filename: 'main.js',
+    path: path.resolve(__dirname, 'dist')
+  },
+  devServer: {
+    static: path.resolve(__dirname, 'dist'),
+    port: 8080,
+    hot: true
+  }
+}
+
    2. +
  2. +

    Next we fill in our dist/index.html. This is the HTML page Webpack will load in the browser to utilize the bundled CSS and JS we’ll add to it in later steps. Before we can do that, we have to give it something to render and include the output JS from the previous step.

    +
    <!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Bootstrap w/ Webpack</title>
+  </head>
+  <body>
+    <div class="container py-4 px-3 mx-auto">
+      <h1>Hello, Bootstrap and Webpack!</h1>
+      <button class="btn btn-primary">Primary button</button>
+    </div>
+    <script src="./main.js"></script>
+  </body>
+</html>
+

    We’re including a little bit of Bootstrap styling here with the div class="container" and <button> so that we see when Bootstrap’s CSS is loaded by Webpack.

    +
    3. +
  3. +

    Now we need an npm script to run Webpack. Open package.json and add the start script shown below (you should already have the test script). We’ll use this script to start our local Webpack dev server.

    +
    {
+  // ...
+  "scripts": {
+    "start": "webpack serve --mode development",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  // ...
+}
+
    4. +
  4. +

    And finally, we can start Webpack. From the my-project folder in your terminal, run that newly added npm script:

    +
    npm start
+
    Webpack dev server running +
    5. +
+

In the next and final section to this guide, we’ll set up the Webpack loaders and import all of Bootstrap’s CSS and JavaScript.

+

Import Bootstrap

+

Importing Bootstrap into Webpack requires the loaders we installed in the first section. We’ve installed them with npm, but now Webpack needs to be configured to use them.

+
    +
  1. +

    Set up the loaders in webpack.config.js. Your configuration file is now complete and should match the snippet below. The only new part here is the module section.

    +
    const path = require('path')
+
+module.exports = {
+  entry: './src/js/main.js',
+  output: {
+    filename: 'main.js',
+    path: path.resolve(__dirname, 'dist')
+  },
+  devServer: {
+    static: path.resolve(__dirname, 'dist'),
+    port: 8080,
+    hot: true
+  },
+  module: {
+    rules: [
+      {
+        test: /\.(scss)$/,
+        use: [
+          {
+            loader: 'style-loader'
+          },
+          {
+            loader: 'css-loader'
+          },
+          {
+            loader: 'postcss-loader',
+            options: {
+              postcssOptions: {
+                plugins: () => [
+                  require('autoprefixer')
+                ]
+              }
+            }
+          },
+          {
+            loader: 'sass-loader'
+          }
+        ]
+      }
+    ]
+  }
+}
+

    Here’s a recap of why we need all these loaders. style-loader injects the CSS into a <style> element in the <head> of the HTML page, css-loader helps with using @import and url(), postcss-loader is required for Autoprefixer, and sass-loader allows us to use Sass.

    +
    2. +
  2. +

    Now, let’s import Bootstrap’s CSS. Add the following to src/scss/styles.scss to import all of Bootstrap’s source Sass.

    +
    // Import all of Bootstrap's CSS
+@import "~bootstrap/scss/bootstrap";
+

    You can also import our stylesheets individually if you want. Read our Sass import docs for details.

    +
    3. +
  3. +

    Next we load the CSS and import Bootstrap’s JavaScript. Add the following to src/js/main.js to load the CSS and import all of Bootstrap’s JS. Popper will be imported automatically through Bootstrap.

    + +
    // Import our custom CSS
+import '../scss/styles.scss'
+
+// Import all of Bootstrap's JS
+import * as bootstrap from 'bootstrap'
+

    You can also import JavaScript plugins individually as needed to keep bundle sizes down:

    + +
    import Alert from 'bootstrap/js/dist/alert'
+
+// or, specify which plugins you need:
+import { Tooltip, Toast, Popover } from 'bootstrap'
+

    Read our JavaScript docs for more information on how to use Bootstrap’s plugins.

    +
    4. +
  4. +

    And you’re done! 🎉 With Bootstrap’s source Sass and JS fully loaded, your local development server should now look like this.

    +Webpack dev server running with Bootstrap +

    Now you can start adding any Bootstrap components you want to use. Be sure to check out the complete Webpack example project for how to include additional custom Sass and optimize your build by importing only the parts of Bootstrap’s CSS and JS that you need.

    +
    5. +
+

Production optimizations

+

Depending on your setup, you may want to implement some additional security and speed optimizations useful for running the project in production. Note that these optimizations are not applied on the Webpack example project and are up to you to implement.

+

Extracting CSS

+

The style-loader we configured above conveniently emits CSS into the bundle so that manually loading a CSS file in dist/index.html isn’t necessary. This approach may not work with a strict Content Security Policy, however, and it may become a bottleneck in your application due to the large bundle size.

+

To separate the CSS so that we can load it directly from dist/index.html, use the mini-css-extract-loader Webpack plugin.

+

First, install the plugin:

+
npm install --save-dev mini-css-extract-plugin
+

Then instantiate and use the plugin in the Webpack configuration:

+
--- a/webpack/webpack.config.js
++++ b/webpack/webpack.config.js
+@@ -1,8 +1,10 @@
++const miniCssExtractPlugin = require('mini-css-extract-plugin')
+ const path = require('path')
+ 
+ module.exports = {
+   mode: 'development',
+   entry: './src/js/main.js',
++  plugins: [new miniCssExtractPlugin()],
+   output: {
+     filename: "main.js",
+     path: path.resolve(__dirname, "dist"),
+@@ -18,8 +20,8 @@ module.exports = {
+         test: /\.(scss)$/,
+         use: [
+           {
+-            // Adds CSS to the DOM by injecting a `<style>` tag
+-            loader: 'style-loader'
++            // Extracts CSS for each JS file that includes CSS
++            loader: miniCssExtractPlugin.loader
+           },
+           {
+

After running npm run build again, there will be a new file dist/main.css, which will contain all of the CSS imported by src/js/main.js. If you view dist/index.html in your browser now, the style will be missing, as it is now in dist/main.css. You can include the generated CSS in dist/index.html like this:

+
--- a/webpack/dist/index.html
++++ b/webpack/dist/index.html
+@@ -3,6 +3,7 @@
+   <head>
+     <meta charset="utf-8">
+     <meta name="viewport" content="width=device-width, initial-scale=1">
++    <link rel="stylesheet" href="./main.css">
+     <title>Bootstrap w/ Webpack</title>
+   </head>
+   <body>
+

Extracting SVG files

+

Bootstrap’s CSS includes multiple references to SVG files via inline data: URIs. If you define a Content Security Policy for your project that blocks data: URIs for images, then these SVG files will not load. You can get around this problem by extracting the inline SVG files using Webpack’s asset modules feature.

+

Configure Webpack to extract inline SVG files like this:

+
--- a/webpack/webpack.config.js
++++ b/webpack/webpack.config.js
+@@ -16,6 +16,14 @@ module.exports = {
+   },
+   module: {
+     rules: [
++      {
++        mimetype: 'image/svg+xml',
++        scheme: 'data',
++        type: 'asset/resource',
++        generator: {
++          filename: 'icons/[hash].svg'
++        }
++      },
+       {
+         test: /\.(scss)$/,
+         use: [
+

After running npm run build again, you’ll find the SVG files extracted into dist/icons and properly referenced from CSS.

+
+

See something wrong or out of date here? Please open an issue on GitHub. Need help troubleshooting? Search or start a discussion on GitHub. + +

+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/helpers/clearfix/index.html b/docs/5.3/helpers/clearfix/index.html new file mode 100644 index 0000000000..6f9c3b6a47 --- /dev/null +++ b/docs/5.3/helpers/clearfix/index.html @@ -0,0 +1,711 @@ + + + + + + + + + + + + +Clearfix · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Clearfix

+
+

Quickly and easily clear floated content within a container by adding a clearfix utility.

+ + +
+ + + +
+ + +

Easily clear floats by adding .clearfix to the parent element. Can also be used as a mixin.

+

Use in HTML:

+
<div class="clearfix">...</div>
+

The mixin source code:

+
@mixin clearfix() {
+  &::after {
+    display: block;
+    clear: both;
+    content: "";
+  }
+}
+
+

Use the mixin in SCSS:

+
.element {
+  @include clearfix;
+}
+

The following example shows how the clearfix can be used. Without the clearfix the wrapping div would not span around the buttons which would cause a broken layout.

+
+
+ + +
+
+ html +
+ + +
+ 
<div class="bg-info clearfix">
+  <button type="button" class="btn btn-secondary float-start">Example Button floated left</button>
+  <button type="button" class="btn btn-secondary float-end">Example Button floated right</button>
+</div>
+ + +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/helpers/color-background/index.html b/docs/5.3/helpers/color-background/index.html new file mode 100644 index 0000000000..740260831d --- /dev/null +++ b/docs/5.3/helpers/color-background/index.html @@ -0,0 +1,781 @@ + + + + + + + + + + + + +Color and background · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
Added in v5.2 + View on GitHub + +
+

Color and background

+
+

Set a background color with contrasting foreground color.

+ + +
+ + +
+ + On this page +
+
+ +
+
+ + +
+ + +

Overview

+

Color and background helpers combine the power of our .text-* utilities and .bg-* utilities in one class. Using our Sass color-contrast() function, we automatically determine a contrasting color for a particular background-color.

+
+Heads up! There’s currently no support for a CSS-native color-contrast function, so we use our own via Sass. This means that customizing our theme colors via CSS variables may cause color contrast issues with these utilities. +
+ +
+ +
Primary with contrasting color
+
Secondary with contrasting color
+
Success with contrasting color
+
Danger with contrasting color
+
Warning with contrasting color
+
Info with contrasting color
+
Light with contrasting color
+
Dark with contrasting color
+
+ html +
+ + +
+ 
<div class="text-bg-primary p-3">Primary with contrasting color</div>
+<div class="text-bg-secondary p-3">Secondary with contrasting color</div>
+<div class="text-bg-success p-3">Success with contrasting color</div>
+<div class="text-bg-danger p-3">Danger with contrasting color</div>
+<div class="text-bg-warning p-3">Warning with contrasting color</div>
+<div class="text-bg-info p-3">Info with contrasting color</div>
+<div class="text-bg-light p-3">Light with contrasting color</div>
+<div class="text-bg-dark p-3">Dark with contrasting color</div>
+ +

With components

+

Use them in place of combined .text-* and .bg-* classes, like on badges:

+
+Primary +Info +
+ html +
+ + +
+ 
<span class="badge text-bg-primary">Primary</span>
+<span class="badge text-bg-info">Info</span>
+ +

Or on cards:

+
+
+
Header
+
+

Some quick example text to build on the card title and make up the bulk of the card's content.

+
+
+
+
Header
+
+

Some quick example text to build on the card title and make up the bulk of the card's content.

+
+
+
+ html +
+ + +
+ 
<div class="card text-bg-primary mb-3" style="max-width: 18rem;">
+  <div class="card-header">Header</div>
+  <div class="card-body">
+    <p class="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+  </div>
+</div>
+<div class="card text-bg-info mb-3" style="max-width: 18rem;">
+  <div class="card-header">Header</div>
+  <div class="card-body">
+    <p class="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+  </div>
+</div>
+ + +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/helpers/colored-links/index.html b/docs/5.3/helpers/colored-links/index.html new file mode 100644 index 0000000000..cade730807 --- /dev/null +++ b/docs/5.3/helpers/colored-links/index.html @@ -0,0 +1,708 @@ + + + + + + + + + + + + +Colored links · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Colored links

+
+

Colored links with hover states

+ + +
+ + + +
+ + +

You can use the .link-* classes to colorize links. Unlike the .text-* classes, these classes have a :hover and :focus state.

+
+ +Primary link +Secondary link +Success link +Danger link +Warning link +Info link +Light link +Dark link +
+ html +
+ + +
+ 
<a href="#" class="link-primary">Primary link</a>
+<a href="#" class="link-secondary">Secondary link</a>
+<a href="#" class="link-success">Success link</a>
+<a href="#" class="link-danger">Danger link</a>
+<a href="#" class="link-warning">Warning link</a>
+<a href="#" class="link-info">Info link</a>
+<a href="#" class="link-light">Light link</a>
+<a href="#" class="link-dark">Dark link</a>
+ +
+Some of the link styles use a relatively light foreground color, and should only be used on a dark background in order to have sufficient contrast. +
+ + +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/helpers/index.html b/docs/5.3/helpers/index.html new file mode 100644 index 0000000000..95c8620313 --- /dev/null +++ b/docs/5.3/helpers/index.html @@ -0,0 +1,12 @@ + + + + + + https://getbootstrap.com/docs/5.3/helpers/clearfix/ + + + + + + diff --git a/docs/5.3/helpers/position/index.html b/docs/5.3/helpers/position/index.html new file mode 100644 index 0000000000..15c9cc9b7a --- /dev/null +++ b/docs/5.3/helpers/position/index.html @@ -0,0 +1,721 @@ + + + + + + + + + + + + +Position · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Position

+
+

Use these helpers for quickly configuring the position of an element.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Fixed top

+

Position an element at the top of the viewport, from edge to edge. Be sure you understand the ramifications of fixed position in your project; you may need to add additional CSS.

+
<div class="fixed-top">...</div>
+

Fixed bottom

+

Position an element at the bottom of the viewport, from edge to edge. Be sure you understand the ramifications of fixed position in your project; you may need to add additional CSS.

+
<div class="fixed-bottom">...</div>
+

Sticky top

+

Position an element at the top of the viewport, from edge to edge, but only after you scroll past it.

+
<div class="sticky-top">...</div>
+

Responsive sticky top

+

Responsive variations also exist for .sticky-top utility.

+
<div class="sticky-sm-top">Stick to the top on viewports sized SM (small) or wider</div>
+<div class="sticky-md-top">Stick to the top on viewports sized MD (medium) or wider</div>
+<div class="sticky-lg-top">Stick to the top on viewports sized LG (large) or wider</div>
+<div class="sticky-xl-top">Stick to the top on viewports sized XL (extra-large) or wider</div>
+<div class="sticky-xxl-top">Stick to the top on viewports sized XXL (extra-extra-large) or wider</div>
+

Sticky bottom

+

Position an element at the bottom of the viewport, from edge to edge, but only after you scroll past it.

+
<div class="sticky-bottom">...</div>
+

Responsive sticky bottom

+

Responsive variations also exist for .sticky-bottom utility.

+
<div class="sticky-sm-bottom">Stick to the bottom on viewports sized SM (small) or wider</div>
+<div class="sticky-md-bottom">Stick to the bottom on viewports sized MD (medium) or wider</div>
+<div class="sticky-lg-bottom">Stick to the bottom on viewports sized LG (large) or wider</div>
+<div class="sticky-xl-bottom">Stick to the bottom on viewports sized XL (extra-large) or wider</div>
+<div class="sticky-xxl-bottom">Stick to the bottom on viewports sized XXL (extra-extra-large) or wider</div>
+
+
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/helpers/ratio/index.html b/docs/5.3/helpers/ratio/index.html new file mode 100644 index 0000000000..011ab44fef --- /dev/null +++ b/docs/5.3/helpers/ratio/index.html @@ -0,0 +1,813 @@ + + + + + + + + + + + + +Ratios · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Ratios

+
+

Use generated pseudo elements to make an element maintain the aspect ratio of your choosing. Perfect for responsively handling video or slideshow embeds based on the width of the parent.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

About

+

Use the ratio helper to manage the aspect ratios of external content like <iframe>s, <embed>s, <video>s, and <object>s. These helpers also can be used on any standard HTML child element (e.g., a <div> or <img>). Styles are applied from the parent .ratio class directly to the child.

+

Aspect ratios are declared in a Sass map and included in each class via CSS variable, which also allows custom aspect ratios.

+
+Pro-Tip! You don’t need frameborder="0" on your <iframe>s as we override that for you in Reboot. +
+ +

Example

+

Wrap any embed, like an <iframe>, in a parent element with .ratio and an aspect ratio class. The immediate child element is automatically sized thanks to our universal selector .ratio > *.

+
+
+ +
+
+ html +
+ + +
+ 
<div class="ratio ratio-16x9">
+  <iframe src="https://www.youtube.com/embed/zpOULjyy-n8?rel=0" title="YouTube video" allowfullscreen></iframe>
+</div>
+ +

Aspect ratios

+

Aspect ratios can be customized with modifier classes. By default the following ratio classes are provided:

+
+
+
1x1
+
+
+
4x3
+
+
+
16x9
+
+
+
21x9
+
+
+ html +
+ + +
+ 
<div class="ratio ratio-1x1">
+  <div>1x1</div>
+</div>
+<div class="ratio ratio-4x3">
+  <div>4x3</div>
+</div>
+<div class="ratio ratio-16x9">
+  <div>16x9</div>
+</div>
+<div class="ratio ratio-21x9">
+  <div>21x9</div>
+</div>
+ +

Custom ratios

+

Each .ratio-* class includes a CSS custom property (or CSS variable) in the selector. You can override this CSS variable to create custom aspect ratios on the fly with some quick math on your part.

+

For example, to create a 2x1 aspect ratio, set --bs-aspect-ratio: 50% on the .ratio.

+
+
+
2x1
+
+
+ html +
+ + +
+ 
<div class="ratio" style="--bs-aspect-ratio: 50%;">
+  <div>2x1</div>
+</div>
+ +

This CSS variable makes it easy to modify the aspect ratio across breakpoints. The following is 4x3 to start, but changes to a custom 2x1 at the medium breakpoint.

+
.ratio-4x3 {
+  @include media-breakpoint-up(md) {
+    --bs-aspect-ratio: 50%; // 2x1
+  }
+}
+
+
+
4x3, then 2x1
+
+
+ html +
+ + +
+ 
<div class="ratio ratio-4x3">
+  <div>4x3, then 2x1</div>
+</div>
+ +

Sass map

+

Within _variables.scss, you can change the aspect ratios you want to use. Here’s our default $ratio-aspect-ratios map. Modify the map as you like and recompile your Sass to put them to use.

+
$aspect-ratios: (
+  "1x1": 100%,
+  "4x3": calc(3 / 4 * 100%),
+  "16x9": calc(9 / 16 * 100%),
+  "21x9": calc(9 / 21 * 100%)
+);
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/helpers/screen-readers/index.html b/docs/5.3/helpers/screen-readers/index.html new file mode 100644 index 0000000000..75f3a5758c --- /dev/null +++ b/docs/5.3/helpers/screen-readers/index.html @@ -0,0 +1,12 @@ + + + + + + https://getbootstrap.com/docs/5.3/helpers/visually-hidden/ + + + + + + diff --git a/docs/5.3/helpers/stacks/index.html b/docs/5.3/helpers/stacks/index.html new file mode 100644 index 0000000000..d0568c8169 --- /dev/null +++ b/docs/5.3/helpers/stacks/index.html @@ -0,0 +1,856 @@ + + + + + + + + + + + + +Stacks · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
Added in v5.1 + View on GitHub + +
+

Stacks

+
+

Shorthand helpers that build on top of our flexbox utilities to make component layout faster and easier than ever.

+ + +
+ + +
+ + On this page +
+
+ +
+
+ + +
+ + +

Stacks offer a shortcut for applying a number of flexbox properties to quickly and easily create layouts in Bootstrap. All credit for the concept and implementation goes to the open source Pylon project.

+
+Heads up! Support for gap utilities with flexbox was recently added to Safari, so consider verifying your intended browser support. Grid layout should have no issues. Read more. +
+ +

Vertical

+

Use .vstack to create vertical layouts. Stacked items are full-width by default. Use .gap-* utilities to add space between items.

+
+
+
First item
+
Second item
+
Third item
+
+
+ html +
+ + +
+ 
<div class="vstack gap-3">
+  <div class="bg-body-tertiary border">First item</div>
+  <div class="bg-body-tertiary border">Second item</div>
+  <div class="bg-body-tertiary border">Third item</div>
+</div>
+ +

Horizontal

+

Use .hstack for horizontal layouts. Stacked items are vertically centered by default and only take up their necessary width. Use .gap-* utilities to add space between items.

+
+
+
First item
+
Second item
+
Third item
+
+
+ html +
+ + +
+ 
<div class="hstack gap-3">
+  <div class="bg-body-tertiary border">First item</div>
+  <div class="bg-body-tertiary border">Second item</div>
+  <div class="bg-body-tertiary border">Third item</div>
+</div>
+ +

Using horizontal margin utilities like .ms-auto as spacers:

+
+
+
First item
+
Second item
+
Third item
+
+
+ html +
+ + +
+ 
<div class="hstack gap-3">
+  <div class="bg-body-tertiary border">First item</div>
+  <div class="bg-body-tertiary border ms-auto">Second item</div>
+  <div class="bg-body-tertiary border">Third item</div>
+</div>
+ +

And with vertical rules:

+
+
+
First item
+
Second item
+
+
Third item
+
+
+ html +
+ + +
+ 
<div class="hstack gap-3">
+  <div class="bg-body-tertiary border">First item</div>
+  <div class="bg-body-tertiary border ms-auto">Second item</div>
+  <div class="vr"></div>
+  <div class="bg-body-tertiary border">Third item</div>
+</div>
+ +

Examples

+

Use .vstack to stack buttons and other elements:

+
+
+ + +
+
+ html +
+ + +
+ 
<div class="vstack gap-2 col-md-5 mx-auto">
+  <button type="button" class="btn btn-secondary">Save changes</button>
+  <button type="button" class="btn btn-outline-secondary">Cancel</button>
+</div>
+ +

Create an inline form with .hstack:

+
+
+ + +
+ +
+
+ html +
+ + +
+ 
<div class="hstack gap-3">
+  <input class="form-control me-auto" type="text" placeholder="Add your item here..." aria-label="Add your item here...">
+  <button type="button" class="btn btn-secondary">Submit</button>
+  <div class="vr"></div>
+  <button type="button" class="btn btn-outline-danger">Reset</button>
+</div>
+ +

Sass

+
.hstack {
+  display: flex;
+  flex-direction: row;
+  align-items: center;
+  align-self: stretch;
+}
+
+.vstack {
+  display: flex;
+  flex: 1 1 auto;
+  flex-direction: column;
+  align-self: stretch;
+}
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/helpers/stretched-link/index.html b/docs/5.3/helpers/stretched-link/index.html new file mode 100644 index 0000000000..6be5a24df4 --- /dev/null +++ b/docs/5.3/helpers/stretched-link/index.html @@ -0,0 +1,812 @@ + + + + + + + + + + + + +Stretched link · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Stretched link

+
+

Make any HTML element or Bootstrap component clickable by “stretching” a nested link via CSS.

+ + +
+ + + +
+ + +

Add .stretched-link to a link to make its containing block clickable via a ::after pseudo element. In most cases, this means that an element with position: relative; that contains a link with the .stretched-link class is clickable. Please note given how CSS position works, .stretched-link cannot be mixed with most table elements.

+

Cards have position: relative by default in Bootstrap, so in this case you can safely add the .stretched-link class to a link in the card without any other HTML changes.

+

Multiple links and tap targets are not recommended with stretched links. However, some position and z-index styles can help should this be required.

+
+
+ Card image cap +
+
Card with stretched link
+

Some quick example text to build on the card title and make up the bulk of the card's content.

+ Go somewhere +
+
+
+ html +
+ + +
+ 
<div class="card" style="width: 18rem;">
+  <img src="..." class="card-img-top" alt="...">
+  <div class="card-body">
+    <h5 class="card-title">Card with stretched link</h5>
+    <p class="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+    <a href="#" class="btn btn-primary stretched-link">Go somewhere</a>
+  </div>
+</div>
+ +

Most custom components do not have position: relative by default, so we need to add the .position-relative here to prevent the link from stretching outside the parent element.

+
+
+ Generic placeholder image +
+
Custom component with stretched link
+

This is some placeholder content for the custom component. It is intended to mimic what some real-world content would look like, and we're using it here to give the component a bit of body and size.

+ Go somewhere +
+
+
+ html +
+ + +
+ 
<div class="d-flex position-relative">
+  <img src="..." class="flex-shrink-0 me-3" alt="...">
+  <div>
+    <h5 class="mt-0">Custom component with stretched link</h5>
+    <p>This is some placeholder content for the custom component. It is intended to mimic what some real-world content would look like, and we're using it here to give the component a bit of body and size.</p>
+    <a href="#" class="stretched-link">Go somewhere</a>
+  </div>
+</div>
+ +
+
+
+ Generic placeholder image +
+
+
Columns with stretched link
+

Another instance of placeholder content for this other custom component. It is intended to mimic what some real-world content would look like, and we're using it here to give the component a bit of body and size.

+ Go somewhere +
+
+
+ html +
+ + +
+ 
<div class="row g-0 bg-body-secondary position-relative">
+  <div class="col-md-6 mb-md-0 p-md-4">
+    <img src="..." class="w-100" alt="...">
+  </div>
+  <div class="col-md-6 p-4 ps-md-0">
+    <h5 class="mt-0">Columns with stretched link</h5>
+    <p>Another instance of placeholder content for this other custom component. It is intended to mimic what some real-world content would look like, and we're using it here to give the component a bit of body and size.</p>
+    <a href="#" class="stretched-link">Go somewhere</a>
+  </div>
+</div>
+ +

Identifying the containing block

+

If the stretched link doesn’t seem to work, the containing block will probably be the cause. The following CSS properties will make an element the containing block:

+
    +
  • A position value other than static
    • +
  • A transform or perspective value other than none
    • +
  • A will-change value of transform or perspective
    • +
  • A filter value other than none or a will-change value of filter (only works on Firefox)
    • +
+
+
+ Card image cap +
+
Card with stretched links
+

Some quick example text to build on the card title and make up the bulk of the card's content.

+

+ Stretched link will not work here, because position: relative is added to the link +

+

+ This stretched link will only be spread over the p-tag, because a transform is applied to it. +

+
+
+
+ html +
+ + +
+ 
<div class="card" style="width: 18rem;">
+  <img src="..." class="card-img-top" alt="...">
+  <div class="card-body">
+    <h5 class="card-title">Card with stretched links</h5>
+    <p class="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+    <p class="card-text">
+      <a href="#" class="stretched-link text-danger" style="position: relative;">Stretched link will not work here, because <code>position: relative</code> is added to the link</a>
+    </p>
+    <p class="card-text bg-light" style="transform: rotate(0);">
+      This <a href="#" class="text-warning stretched-link">stretched link</a> will only be spread over the <code>p</code>-tag, because a transform is applied to it.
+    </p>
+  </div>
+</div>
+ + +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/helpers/text-truncation/index.html b/docs/5.3/helpers/text-truncation/index.html new file mode 100644 index 0000000000..aeabc20d18 --- /dev/null +++ b/docs/5.3/helpers/text-truncation/index.html @@ -0,0 +1,709 @@ + + + + + + + + + + + + +Text truncation · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Text truncation

+
+

Truncate long strings of text with an ellipsis.

+ + +
+ + + +
+ + +

For longer content, you can add a .text-truncate class to truncate the text with an ellipsis. Requires display: inline-block or display: block.

+
+ +
+
+ This text is quite long, and will be truncated once displayed. +
+
+ + + + This text is quite long, and will be truncated once displayed. + +
+ html +
+ + +
+ 
<!-- Block level -->
+<div class="row">
+  <div class="col-2 text-truncate">
+    This text is quite long, and will be truncated once displayed.
+  </div>
+</div>
+
+<!-- Inline level -->
+<span class="d-inline-block text-truncate" style="max-width: 150px;">
+  This text is quite long, and will be truncated once displayed.
+</span>
+ + +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/helpers/vertical-rule/index.html b/docs/5.3/helpers/vertical-rule/index.html new file mode 100644 index 0000000000..267a6bb9bd --- /dev/null +++ b/docs/5.3/helpers/vertical-rule/index.html @@ -0,0 +1,760 @@ + + + + + + + + + + + + +Vertical rule · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
Added in v5.1 + View on GitHub + +
+

Vertical rule

+
+

Use the custom vertical rule helper to create vertical dividers like the <hr> element.

+ + +
+ + +
+ + On this page +
+
+ +
+
+ + +
+ + +

How it works

+

Vertical rules are inspired by the <hr> element, allowing you to create vertical dividers in common layouts. They’re styled just like <hr> elements:

+
    +
  • They’re 1px wide
    • +
  • They have min-height of 1em
    • +
  • Their color is set via currentColor and opacity
    • +
+

Customize them with additional styles as needed.

+

Example

+
+
+
+ html +
+ + +
+ 
<div class="vr"></div>
+ +

Vertical rules scale their height in flex layouts:

+
+
+
+
+
+ html +
+ + +
+ 
<div class="d-flex" style="height: 200px;">
+  <div class="vr"></div>
+</div>
+ +

With stacks

+

They can also be used in stacks:

+
+
+
First item
+
Second item
+
+
Third item
+
+
+ html +
+ + +
+ 
<div class="hstack gap-3">
+  <div class="bg-body-tertiary border">First item</div>
+  <div class="bg-body-tertiary border ms-auto">Second item</div>
+  <div class="vr"></div>
+  <div class="bg-body-tertiary border">Third item</div>
+</div>
+ + +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/helpers/visually-hidden/index.html b/docs/5.3/helpers/visually-hidden/index.html new file mode 100644 index 0000000000..a8b0a4e2f4 --- /dev/null +++ b/docs/5.3/helpers/visually-hidden/index.html @@ -0,0 +1,703 @@ + + + + + + + + + + + + +Visually hidden · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Visually hidden

+
+

Use these helpers to visually hide elements but keep them accessible to assistive technologies.

+ + +
+ + + +
+ + +

Visually hide an element while still allowing it to be exposed to assistive technologies (such as screen readers) with .visually-hidden. Use .visually-hidden-focusable to visually hide an element by default, but to display it when it’s focused (e.g. by a keyboard-only user). .visually-hidden-focusable can also be applied to a container–thanks to :focus-within, the container will be displayed when any child element of the container receives focus.

+
+ +Skip to main content +
A container with a focusable element.
+
+ html +
+ + +
+ 
<h2 class="visually-hidden">Title for screen readers</h2>
+<a class="visually-hidden-focusable" href="#content">Skip to main content</a>
+<div class="visually-hidden-focusable">A container with a <a href="#">focusable element</a>.</div>
+ +

Both visually-hidden and visually-hidden-focusable can also be used as mixins.

+
// Usage as a mixin
+
+.visually-hidden-title {
+  @include visually-hidden;
+}
+
+.skip-navigation {
+  @include visually-hidden-focusable;
+}
+
+
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/index.html b/docs/5.3/index.html new file mode 100644 index 0000000000..349df656a8 --- /dev/null +++ b/docs/5.3/index.html @@ -0,0 +1,12 @@ + + + + + + https://getbootstrap.com/docs/5.3/getting-started/introduction/ + + + + + + diff --git a/docs/5.3/layout/breakpoints/index.html b/docs/5.3/layout/breakpoints/index.html new file mode 100644 index 0000000000..15a5f7f2d7 --- /dev/null +++ b/docs/5.3/layout/breakpoints/index.html @@ -0,0 +1,863 @@ + + + + + + + + + + + + +Breakpoints · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Breakpoints

+
+

Breakpoints are customizable widths that determine how your responsive layout behaves across device or viewport sizes in Bootstrap.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Core concepts

+
    +
  • +

    Breakpoints are the building blocks of responsive design. Use them to control when your layout can be adapted at a particular viewport or device size.

    +
    • +
  • +

    Use media queries to architect your CSS by breakpoint. Media queries are a feature of CSS that allow you to conditionally apply styles based on a set of browser and operating system parameters. We most commonly use min-width in our media queries.

    +
    • +
  • +

    Mobile first, responsive design is the goal. Bootstrap’s CSS aims to apply the bare minimum of styles to make a layout work at the smallest breakpoint, and then layers on styles to adjust that design for larger devices. This optimizes your CSS, improves rendering time, and provides a great experience for your visitors.

    +
    • +
+

Available breakpoints

+

Bootstrap includes six default breakpoints, sometimes referred to as grid tiers, for building responsively. These breakpoints can be customized if you’re using our source Sass files.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BreakpointClass infixDimensions
Extra smallNone<576px
Smallsm≥576px
Mediummd≥768px
Largelg≥992px
Extra largexl≥1200px
Extra extra largexxl≥1400px
+ +

Each breakpoint was chosen to comfortably hold containers whose widths are multiples of 12. Breakpoints are also representative of a subset of common device sizes and viewport dimensions—they don’t specifically target every use case or device. Instead, the ranges provide a strong and consistent foundation to build on for nearly any device.

+

These breakpoints are customizable via Sass—you’ll find them in a Sass map in our _variables.scss stylesheet.

+
$grid-breakpoints: (
+  xs: 0,
+  sm: 576px,
+  md: 768px,
+  lg: 992px,
+  xl: 1200px,
+  xxl: 1400px
+);
+
+

For more information and examples on how to modify our Sass maps and variables, please refer to the Sass section of the Grid documentation.

+

Media queries

+

Since Bootstrap is developed to be mobile first, we use a handful of media queries to create sensible breakpoints for our layouts and interfaces. These breakpoints are mostly based on minimum viewport widths and allow us to scale up elements as the viewport changes.

+

Min-width

+

Bootstrap primarily uses the following media query ranges—or breakpoints—in our source Sass files for our layout, grid system, and components.

+
// Source mixins
+
+// No media query necessary for xs breakpoint as it's effectively `@media (min-width: 0) { ... }`
+@include media-breakpoint-up(sm) { ... }
+@include media-breakpoint-up(md) { ... }
+@include media-breakpoint-up(lg) { ... }
+@include media-breakpoint-up(xl) { ... }
+@include media-breakpoint-up(xxl) { ... }
+
+// Usage
+
+// Example: Hide starting at `min-width: 0`, and then show at the `sm` breakpoint
+.custom-class {
+  display: none;
+}
+@include media-breakpoint-up(sm) {
+  .custom-class {
+    display: block;
+  }
+}
+

These Sass mixins translate in our compiled CSS using the values declared in our Sass variables. For example:

+
// X-Small devices (portrait phones, less than 576px)
+// No media query for `xs` since this is the default in Bootstrap
+
+// Small devices (landscape phones, 576px and up)
+@media (min-width: 576px) { ... }
+
+// Medium devices (tablets, 768px and up)
+@media (min-width: 768px) { ... }
+
+// Large devices (desktops, 992px and up)
+@media (min-width: 992px) { ... }
+
+// X-Large devices (large desktops, 1200px and up)
+@media (min-width: 1200px) { ... }
+
+// XX-Large devices (larger desktops, 1400px and up)
+@media (min-width: 1400px) { ... }
+

Max-width

+

We occasionally use media queries that go in the other direction (the given screen size or smaller):

+
// No media query necessary for xs breakpoint as it's effectively `@media (max-width: 0) { ... }`
+@include media-breakpoint-down(sm) { ... }
+@include media-breakpoint-down(md) { ... }
+@include media-breakpoint-down(lg) { ... }
+@include media-breakpoint-down(xl) { ... }
+@include media-breakpoint-down(xxl) { ... }
+
+// Example: Style from medium breakpoint and down
+@include media-breakpoint-down(md) {
+  .custom-class {
+    display: block;
+  }
+}
+

These mixins take those declared breakpoints, subtract .02px from them, and use them as our max-width values. For example:

+
// `xs` returns only a ruleset and no media query
+// ... { ... }
+
+// `sm` applies to x-small devices (portrait phones, less than 576px)
+@media (max-width: 575.98px) { ... }
+
+// `md` applies to small devices (landscape phones, less than 768px)
+@media (max-width: 767.98px) { ... }
+
+// `lg` applies to medium devices (tablets, less than 992px)
+@media (max-width: 991.98px) { ... }
+
+// `xl` applies to large devices (desktops, less than 1200px)
+@media (max-width: 1199.98px) { ... }
+
+// `xxl` applies to x-large devices (large desktops, less than 1400px)
+@media (max-width: 1399.98px) { ... }
+
+Why subtract .02px? Browsers don’t currently support range context queries, so we work around the limitations of min- and max- prefixes and viewports with fractional widths (which can occur under certain conditions on high-dpi devices, for instance) by using values with higher precision. +
+ +

Single breakpoint

+

There are also media queries and mixins for targeting a single segment of screen sizes using the minimum and maximum breakpoint widths.

+
@include media-breakpoint-only(xs) { ... }
+@include media-breakpoint-only(sm) { ... }
+@include media-breakpoint-only(md) { ... }
+@include media-breakpoint-only(lg) { ... }
+@include media-breakpoint-only(xl) { ... }
+@include media-breakpoint-only(xxl) { ... }
+

For example the @include media-breakpoint-only(md) { ... } will result in :

+
@media (min-width: 768px) and (max-width: 991.98px) { ... }
+

Between breakpoints

+

Similarly, media queries may span multiple breakpoint widths:

+
@include media-breakpoint-between(md, xl) { ... }
+

Which results in:

+
// Example
+// Apply styles starting from medium devices and up to extra large devices
+@media (min-width: 768px) and (max-width: 1199.98px) { ... }
+
+
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/layout/columns/index.html b/docs/5.3/layout/columns/index.html new file mode 100644 index 0000000000..bdcc134871 --- /dev/null +++ b/docs/5.3/layout/columns/index.html @@ -0,0 +1,1367 @@ + + + + + + + + + + + + +Columns · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Columns

+
+

Learn how to modify columns with a handful of options for alignment, ordering, and offsetting thanks to our flexbox grid system. Plus, see how to use column classes to manage widths of non-grid elements.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +
+Heads up! Be sure to read the Grid page first before diving into how to modify and customize your grid columns. +
+ +

How they work

+
    +
  • +

    Columns build on the grid’s flexbox architecture. Flexbox means we have options for changing individual columns and modifying groups of columns at the row level. You choose how columns grow, shrink, or otherwise change.

    +
    • +
  • +

    When building grid layouts, all content goes in columns. The hierarchy of Bootstrap’s grid goes from container to row to column to your content. On rare occasions, you may combine content and column, but be aware there can be unintended consequences.

    +
    • +
  • +

    Bootstrap includes predefined classes for creating fast, responsive layouts. With six breakpoints and a dozen columns at each grid tier, we have dozens of classes already built for you to create your desired layouts. This can be disabled via Sass if you wish.

    +
    • +
+

Alignment

+

Use flexbox alignment utilities to vertically and horizontally align columns.

+

Vertical alignment

+

Change the vertical alignment with any of the responsive align-items-* classes.

+
+
+
+
+ One of three columns +
+
+ One of three columns +
+
+ One of three columns +
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row align-items-start">
+    <div class="col">
+      One of three columns
+    </div>
+    <div class="col">
+      One of three columns
+    </div>
+    <div class="col">
+      One of three columns
+    </div>
+  </div>
+</div>
+ +
+
+
+
+ One of three columns +
+
+ One of three columns +
+
+ One of three columns +
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row align-items-center">
+    <div class="col">
+      One of three columns
+    </div>
+    <div class="col">
+      One of three columns
+    </div>
+    <div class="col">
+      One of three columns
+    </div>
+  </div>
+</div>
+ +
+
+
+
+ One of three columns +
+
+ One of three columns +
+
+ One of three columns +
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row align-items-end">
+    <div class="col">
+      One of three columns
+    </div>
+    <div class="col">
+      One of three columns
+    </div>
+    <div class="col">
+      One of three columns
+    </div>
+  </div>
+</div>
+ +

Or, change the alignment of each column individually with any of the responsive .align-self-* classes.

+
+
+
+
+ One of three columns +
+
+ One of three columns +
+
+ One of three columns +
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col align-self-start">
+      One of three columns
+    </div>
+    <div class="col align-self-center">
+      One of three columns
+    </div>
+    <div class="col align-self-end">
+      One of three columns
+    </div>
+  </div>
+</div>
+ +

Horizontal alignment

+
+
+
+
+ One of two columns +
+
+ One of two columns +
+
+
+
+ One of two columns +
+
+ One of two columns +
+
+
+
+ One of two columns +
+
+ One of two columns +
+
+
+
+ One of two columns +
+
+ One of two columns +
+
+
+
+ One of two columns +
+
+ One of two columns +
+
+
+
+ One of two columns +
+
+ One of two columns +
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row justify-content-start">
+    <div class="col-4">
+      One of two columns
+    </div>
+    <div class="col-4">
+      One of two columns
+    </div>
+  </div>
+  <div class="row justify-content-center">
+    <div class="col-4">
+      One of two columns
+    </div>
+    <div class="col-4">
+      One of two columns
+    </div>
+  </div>
+  <div class="row justify-content-end">
+    <div class="col-4">
+      One of two columns
+    </div>
+    <div class="col-4">
+      One of two columns
+    </div>
+  </div>
+  <div class="row justify-content-around">
+    <div class="col-4">
+      One of two columns
+    </div>
+    <div class="col-4">
+      One of two columns
+    </div>
+  </div>
+  <div class="row justify-content-between">
+    <div class="col-4">
+      One of two columns
+    </div>
+    <div class="col-4">
+      One of two columns
+    </div>
+  </div>
+  <div class="row justify-content-evenly">
+    <div class="col-4">
+      One of two columns
+    </div>
+    <div class="col-4">
+      One of two columns
+    </div>
+  </div>
+</div>
+ +

Column wrapping

+

If more than 12 columns are placed within a single row, each group of extra columns will, as one unit, wrap onto a new line.

+
+
+
+
.col-9
+
.col-4
Since 9 + 4 = 13 > 12, this 4-column-wide div gets wrapped onto a new line as one contiguous unit.
+
.col-6
Subsequent columns continue along the new line.
+
+
+
+ html +
+ + +
+ 
<div class="container">
+  <div class="row">
+    <div class="col-9">.col-9</div>
+    <div class="col-4">.col-4<br>Since 9 + 4 = 13 &gt; 12, this 4-column-wide div gets wrapped onto a new line as one contiguous unit.</div>
+    <div class="col-6">.col-6<br>Subsequent columns continue along the new line.</div>
+  </div>
+</div>
+ +

Column breaks

+

Breaking columns to a new line in flexbox requires a small hack: add an element with width: 100% wherever you want to wrap your columns to a new line. Normally this is accomplished with multiple .rows, but not every implementation method can account for this.

+
+
+
+
.col-6 .col-sm-3
+
.col-6 .col-sm-3
+ + +
+ +
.col-6 .col-sm-3
+
.col-6 .col-sm-3
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col-6 col-sm-3">.col-6 .col-sm-3</div>
+    <div class="col-6 col-sm-3">.col-6 .col-sm-3</div>
+
+    <!-- Force next columns to break to new line -->
+    <div class="w-100"></div>
+
+    <div class="col-6 col-sm-3">.col-6 .col-sm-3</div>
+    <div class="col-6 col-sm-3">.col-6 .col-sm-3</div>
+  </div>
+</div>
+ +

You may also apply this break at specific breakpoints with our responsive display utilities.

+
+
+
+
.col-6 .col-sm-4
+
.col-6 .col-sm-4
+ + +
+ +
.col-6 .col-sm-4
+
.col-6 .col-sm-4
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col-6 col-sm-4">.col-6 .col-sm-4</div>
+    <div class="col-6 col-sm-4">.col-6 .col-sm-4</div>
+
+    <!-- Force next columns to break to new line at md breakpoint and up -->
+    <div class="w-100 d-none d-md-block"></div>
+
+    <div class="col-6 col-sm-4">.col-6 .col-sm-4</div>
+    <div class="col-6 col-sm-4">.col-6 .col-sm-4</div>
+  </div>
+</div>
+ +

Reordering

+

Order classes

+

Use .order- classes for controlling the visual order of your content. These classes are responsive, so you can set the order by breakpoint (e.g., .order-1.order-md-2). Includes support for 1 through 5 across all six grid tiers. If you need more .order-* classes, you can modify the default number via Sass variable.

+
+
+
+
+ First in DOM, no order applied +
+
+ Second in DOM, with a larger order +
+
+ Third in DOM, with an order of 1 +
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col">
+      First in DOM, no order applied
+    </div>
+    <div class="col order-5">
+      Second in DOM, with a larger order
+    </div>
+    <div class="col order-1">
+      Third in DOM, with an order of 1
+    </div>
+  </div>
+</div>
+ +

There are also responsive .order-first and .order-last classes that change the order of an element by applying order: -1 and order: 6, respectively. These classes can also be intermixed with the numbered .order-* classes as needed.

+
+
+
+
+ First in DOM, ordered last +
+
+ Second in DOM, unordered +
+
+ Third in DOM, ordered first +
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col order-last">
+      First in DOM, ordered last
+    </div>
+    <div class="col">
+      Second in DOM, unordered
+    </div>
+    <div class="col order-first">
+      Third in DOM, ordered first
+    </div>
+  </div>
+</div>
+ +

Offsetting columns

+

You can offset grid columns in two ways: our responsive .offset- grid classes and our margin utilities. Grid classes are sized to match columns while margins are more useful for quick layouts where the width of the offset is variable.

+

Offset classes

+

Move columns to the right using .offset-md-* classes. These classes increase the left margin of a column by * columns. For example, .offset-md-4 moves .col-md-4 over four columns.

+
+
+
+
.col-md-4
+
.col-md-4 .offset-md-4
+
+
+
.col-md-3 .offset-md-3
+
.col-md-3 .offset-md-3
+
+
+
.col-md-6 .offset-md-3
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col-md-4">.col-md-4</div>
+    <div class="col-md-4 offset-md-4">.col-md-4 .offset-md-4</div>
+  </div>
+  <div class="row">
+    <div class="col-md-3 offset-md-3">.col-md-3 .offset-md-3</div>
+    <div class="col-md-3 offset-md-3">.col-md-3 .offset-md-3</div>
+  </div>
+  <div class="row">
+    <div class="col-md-6 offset-md-3">.col-md-6 .offset-md-3</div>
+  </div>
+</div>
+ +

In addition to column clearing at responsive breakpoints, you may need to reset offsets. See this in action in the grid example.

+
+
+
+
.col-sm-5 .col-md-6
+
.col-sm-5 .offset-sm-2 .col-md-6 .offset-md-0
+
+
+
.col-sm-6 .col-md-5 .col-lg-6
+
.col-sm-6 .col-md-5 .offset-md-2 .col-lg-6 .offset-lg-0
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col-sm-5 col-md-6">.col-sm-5 .col-md-6</div>
+    <div class="col-sm-5 offset-sm-2 col-md-6 offset-md-0">.col-sm-5 .offset-sm-2 .col-md-6 .offset-md-0</div>
+  </div>
+  <div class="row">
+    <div class="col-sm-6 col-md-5 col-lg-6">.col-sm-6 .col-md-5 .col-lg-6</div>
+    <div class="col-sm-6 col-md-5 offset-md-2 col-lg-6 offset-lg-0">.col-sm-6 .col-md-5 .offset-md-2 .col-lg-6 .offset-lg-0</div>
+  </div>
+</div>
+ +

Margin utilities

+

With the move to flexbox in v4, you can use margin utilities like .me-auto to force sibling columns away from one another.

+
+
+
+
.col-md-4
+
.col-md-4 .ms-auto
+
+
+
.col-md-3 .ms-md-auto
+
.col-md-3 .ms-md-auto
+
+
+
.col-auto .me-auto
+
.col-auto
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col-md-4">.col-md-4</div>
+    <div class="col-md-4 ms-auto">.col-md-4 .ms-auto</div>
+  </div>
+  <div class="row">
+    <div class="col-md-3 ms-md-auto">.col-md-3 .ms-md-auto</div>
+    <div class="col-md-3 ms-md-auto">.col-md-3 .ms-md-auto</div>
+  </div>
+  <div class="row">
+    <div class="col-auto me-auto">.col-auto .me-auto</div>
+    <div class="col-auto">.col-auto</div>
+  </div>
+</div>
+ +

Standalone column classes

+

The .col-* classes can also be used outside a .row to give an element a specific width. Whenever column classes are used as non-direct children of a row, the paddings are omitted.

+
+
+ .col-3: width of 25% +
+ +
+ .col-sm-9: width of 75% above sm breakpoint +
+
+ html +
+ + +
+ 
<div class="col-3 p-3 mb-2">
+  .col-3: width of 25%
+</div>
+
+<div class="col-sm-9 p-3">
+  .col-sm-9: width of 75% above sm breakpoint
+</div>
+ +

The classes can be used together with utilities to create responsive floated images. Make sure to wrap the content in a .clearfix wrapper to clear the float if the text is shorter.

+
+
+ PlaceholderResponsive floated image + +

+ A paragraph of placeholder text. We're using it here to show the use of the clearfix class. We're adding quite a few meaningless phrases here to demonstrate how the columns interact here with the floated image. +

+ +

+ As you can see the paragraphs gracefully wrap around the floated image. Now imagine how this would look with some actual content in here, rather than just this boring placeholder text that goes on and on, but actually conveys no tangible information at. It simply takes up space and should not really be read. +

+ +

+ And yet, here you are, still persevering in reading this placeholder text, hoping for some more insights, or some hidden easter egg of content. A joke, perhaps. Unfortunately, there's none of that here. +

+
+
+ html +
+ + +
+ 
<div class="clearfix">
+  <img src="..." class="col-md-6 float-md-end mb-3 ms-md-3" alt="...">
+
+  <p>
+    A paragraph of placeholder text. We're using it here to show the use of the clearfix class. We're adding quite a few meaningless phrases here to demonstrate how the columns interact here with the floated image.
+  </p>
+
+  <p>
+    As you can see the paragraphs gracefully wrap around the floated image. Now imagine how this would look with some actual content in here, rather than just this boring placeholder text that goes on and on, but actually conveys no tangible information at. It simply takes up space and should not really be read.
+  </p>
+
+  <p>
+    And yet, here you are, still persevering in reading this placeholder text, hoping for some more insights, or some hidden easter egg of content. A joke, perhaps. Unfortunately, there's none of that here.
+  </p>
+</div>
+ + +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/layout/containers/index.html b/docs/5.3/layout/containers/index.html new file mode 100644 index 0000000000..8ed37b393b --- /dev/null +++ b/docs/5.3/layout/containers/index.html @@ -0,0 +1,825 @@ + + + + + + + + + + + + +Containers · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Containers

+
+

Containers are a fundamental building block of Bootstrap that contain, pad, and align your content within a given device or viewport.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

How they work

+

Containers are the most basic layout element in Bootstrap and are required when using our default grid system. Containers are used to contain, pad, and (sometimes) center the content within them. While containers can be nested, most layouts do not require a nested container.

+

Bootstrap comes with three different containers:

+
    +
  • .container, which sets a max-width at each responsive breakpoint
    • +
  • .container-{breakpoint}, which is width: 100% until the specified breakpoint
    • +
  • .container-fluid, which is width: 100% at all breakpoints
    • +
+

The table below illustrates how each container’s max-width compares to the original .container and .container-fluid across each breakpoint.

+

See them in action and compare them in our Grid example.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Extra small
<576px
Small
≥576px
Medium
≥768px
Large
≥992px
X-Large
≥1200px
XX-Large
≥1400px
.container100%540px720px960px1140px1320px
.container-sm100%540px720px960px1140px1320px
.container-md100%100%720px960px1140px1320px
.container-lg100%100%100%960px1140px1320px
.container-xl100%100%100%100%1140px1320px
.container-xxl100%100%100%100%100%1320px
.container-fluid100%100%100%100%100%100%
+ +

Default container

+

Our default .container class is a responsive, fixed-width container, meaning its max-width changes at each breakpoint.

+
<div class="container">
+  <!-- Content here -->
+</div>
+

Responsive containers

+

Responsive containers allow you to specify a class that is 100% wide until the specified breakpoint is reached, after which we apply max-widths for each of the higher breakpoints. For example, .container-sm is 100% wide to start until the sm breakpoint is reached, where it will scale up with md, lg, xl, and xxl.

+
<div class="container-sm">100% wide until small breakpoint</div>
+<div class="container-md">100% wide until medium breakpoint</div>
+<div class="container-lg">100% wide until large breakpoint</div>
+<div class="container-xl">100% wide until extra large breakpoint</div>
+<div class="container-xxl">100% wide until extra extra large breakpoint</div>
+

Fluid containers

+

Use .container-fluid for a full width container, spanning the entire width of the viewport.

+
<div class="container-fluid">
+  ...
+</div>
+

Sass

+

As shown above, Bootstrap generates a series of predefined container classes to help you build the layouts you desire. You may customize these predefined container classes by modifying the Sass map (found in _variables.scss) that powers them:

+
$container-max-widths: (
+  sm: 540px,
+  md: 720px,
+  lg: 960px,
+  xl: 1140px,
+  xxl: 1320px
+);
+
+

In addition to customizing the Sass, you can also create your own containers with our Sass mixin.

+
// Source mixin
+@mixin make-container($padding-x: $container-padding-x) {
+  width: 100%;
+  padding-right: $padding-x;
+  padding-left: $padding-x;
+  margin-right: auto;
+  margin-left: auto;
+}
+
+// Usage
+.custom-container {
+  @include make-container();
+}
+

For more information and examples on how to modify our Sass maps and variables, please refer to the Sass section of the Grid documentation.

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/layout/css-grid/index.html b/docs/5.3/layout/css-grid/index.html new file mode 100644 index 0000000000..3534e6157e --- /dev/null +++ b/docs/5.3/layout/css-grid/index.html @@ -0,0 +1,1203 @@ + + + + + + + + + + + + +CSS Grid · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
Added in v5.1 + View on GitHub + +
+

CSS Grid

+
+

Learn how to enable, use, and customize our alternate layout system built on CSS Grid with examples and code snippets.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Bootstrap’s default grid system represents the culmination of over a decade of CSS layout techniques, tried and tested by millions of people. But, it was also created without many of the modern CSS features and techniques we’re seeing in browsers like the new CSS Grid.

+
+Heads up—our CSS Grid system is experimental and opt-in as of v5.1.0! We included it in our documentation’s CSS to demonstrate it for you, but it’s disabled by default. Keep reading to learn how to enable it in your projects. +
+ +

How it works

+

With Bootstrap 5, we’ve added the option to enable a separate grid system that’s built on CSS Grid, but with a Bootstrap twist. You still get classes you can apply on a whim to build responsive layouts, but with a different approach under the hood.

+
    +
  • +

    CSS Grid is opt-in. Disable the default grid system by setting $enable-grid-classes: false and enable the CSS Grid by setting $enable-cssgrid: true. Then, recompile your Sass.

    +
    • +
  • +

    Replace instances of .row with .grid. The .grid class sets display: grid and creates a grid-template that you build on with your HTML.

    +
    • +
  • +

    Replace .col-* classes with .g-col-* classes. This is because our CSS Grid columns use the grid-column property instead of width.

    +
    • +
  • +

    Columns and gutter sizes are set via CSS variables. Set these on the parent .grid and customize however you want, inline or in a stylesheet, with --bs-columns and --bs-gap.

    +
    • +
+

In the future, Bootstrap will likely shift to a hybrid solution as the gap property has achieved nearly full browser support for flexbox.

+

Key differences

+

Compared to the default grid system:

+
    +
  • +

    Flex utilities don’t affect the CSS Grid columns in the same way.

    +
    • +
  • +

    Gaps replaces gutters. The gap property replaces the horizontal padding from our default grid system and functions more like margin.

    +
    • +
  • +

    As such, unlike .rows, .grids have no negative margins and margin utilities cannot be used to change the grid gutters. Grid gaps are applied horizontally and vertically by default. See the customizing section for more details.

    +
    • +
  • +

    Inline and custom styles should be viewed as replacements for modifier classes (e.g., style="--bs-columns: 3;" vs class="row-cols-3").

    +
    • +
  • +

    Nesting works similarly, but may require you to reset your column counts on each instance of a nested .grid. See the nesting section for details.

    +
    • +
+

Examples

+

Three columns

+

Three equal-width columns across all viewports and devices can be created by using the .g-col-4 classes. Add responsive classes to change the layout by viewport size.

+
+
+
.g-col-4
+
.g-col-4
+
.g-col-4
+
+
+ html +
+ + +
+ 
<div class="grid text-center">
+  <div class="g-col-4">.g-col-4</div>
+  <div class="g-col-4">.g-col-4</div>
+  <div class="g-col-4">.g-col-4</div>
+</div>
+ +

Responsive

+

Use responsive classes to adjust your layout across viewports. Here we start with two columns on the narrowest viewports, and then grow to three columns on medium viewports and above.

+
+
+
.g-col-6 .g-col-md-4
+
.g-col-6 .g-col-md-4
+
.g-col-6 .g-col-md-4
+
+
+ html +
+ + +
+ 
<div class="grid text-center">
+  <div class="g-col-6 g-col-md-4">.g-col-6 .g-col-md-4</div>
+  <div class="g-col-6 g-col-md-4">.g-col-6 .g-col-md-4</div>
+  <div class="g-col-6 g-col-md-4">.g-col-6 .g-col-md-4</div>
+</div>
+ +

Compare that to this two column layout at all viewports.

+
+
+
.g-col-6
+
.g-col-6
+
+
+ html +
+ + +
+ 
<div class="grid text-center">
+  <div class="g-col-6">.g-col-6</div>
+  <div class="g-col-6">.g-col-6</div>
+</div>
+ +

Wrapping

+

Grid items automatically wrap to the next line when there’s no more room horizontally. Note that the gap applies to horizontal and vertical gaps between grid items.

+
+
+
.g-col-6
+
.g-col-6
+ +
.g-col-6
+
.g-col-6
+
+
+ html +
+ + +
+ 
<div class="grid text-center">
+  <div class="g-col-6">.g-col-6</div>
+  <div class="g-col-6">.g-col-6</div>
+
+  <div class="g-col-6">.g-col-6</div>
+  <div class="g-col-6">.g-col-6</div>
+</div>
+ +

Starts

+

Start classes aim to replace our default grid’s offset classes, but they’re not entirely the same. CSS Grid creates a grid template through styles that tell browsers to “start at this column” and “end at this column.” Those properties are grid-column-start and grid-column-end. Start classes are shorthand for the former. Pair them with the column classes to size and align your columns however you need. Start classes begin at 1 as 0 is an invalid value for these properties.

+
+
+
.g-col-3 .g-start-2
+
.g-col-4 .g-start-6
+
+
+ html +
+ + +
+ 
<div class="grid text-center">
+  <div class="g-col-3 g-start-2">.g-col-3 .g-start-2</div>
+  <div class="g-col-4 g-start-6">.g-col-4 .g-start-6</div>
+</div>
+ +

Auto columns

+

When there are no classes on the grid items (the immediate children of a .grid), each grid item will automatically be sized to one column.

+
+
+
1
+
1
+
1
+
1
+
1
+
1
+
1
+
1
+
1
+
1
+
1
+
1
+
+
+ html +
+ + +
+ 
<div class="grid text-center">
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+</div>
+ +

This behavior can be mixed with grid column classes.

+
+
+
.g-col-6
+
1
+
1
+
1
+
1
+
1
+
1
+
+
+ html +
+ + +
+ 
<div class="grid text-center">
+  <div class="g-col-6">.g-col-6</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+  <div>1</div>
+</div>
+ +

Nesting

+

Similar to our default grid system, our CSS Grid allows for easy nesting of .grids. However, unlike the default, this grid inherits changes in the rows, columns, and gaps. Consider the example below:

+
    +
  • We override the default number of columns with a local CSS variable: --bs-columns: 3.
    • +
  • In the first auto-column, the column count is inherited and each column is one-third of the available width.
    • +
  • In the second auto-column, we’ve reset the column count on the nested .grid to 12 (our default).
    • +
  • The third auto-column has no nested content.
    • +
+

In practice this allows for more complex and custom layouts when compared to our default grid system.

+
+
+
+ First auto-column +
+
Auto-column
+
Auto-column
+
+
+
+ Second auto-column +
+
6 of 12
+
4 of 12
+
2 of 12
+
+
+
Third auto-column
+
+
+ html +
+ + +
+ 
<div class="grid text-center" style="--bs-columns: 3;">
+  <div>
+    First auto-column
+    <div class="grid">
+      <div>Auto-column</div>
+      <div>Auto-column</div>
+    </div>
+  </div>
+  <div>
+    Second auto-column
+    <div class="grid" style="--bs-columns: 12;">
+      <div class="g-col-6">6 of 12</div>
+      <div class="g-col-4">4 of 12</div>
+      <div class="g-col-2">2 of 12</div>
+    </div>
+  </div>
+  <div>Third auto-column</div>
+</div>
+ +

Customizing

+

Customize the number of columns, the number of rows, and the width of the gaps with local CSS variables.

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
VariableFallback valueDescription
--bs-rows1The number of rows in your grid template
--bs-columns12The number of columns in your grid template
--bs-gap1.5remThe size of the gap between columns (vertical and horizontal)
+ +

These CSS variables have no default value; instead, they apply fallback values that are used until a local instance is provided. For example, we use var(--bs-rows, 1) for our CSS Grid rows, which ignores --bs-rows because that hasn’t been set anywhere yet. Once it is, the .grid instance will use that value instead of the fallback value of 1.

+

No grid classes

+

Immediate children elements of .grid are grid items, so they’ll be sized without explicitly adding a .g-col class.

+
+
+
Auto-column
+
Auto-column
+
Auto-column
+
+
+ html +
+ + +
+ 
<div class="grid text-center" style="--bs-columns: 3;">
+  <div>Auto-column</div>
+  <div>Auto-column</div>
+  <div>Auto-column</div>
+</div>
+ +

Columns and gaps

+

Adjust the number of columns and the gap.

+
+
+
.g-col-2
+
.g-col-2
+
+
+ html +
+ + +
+ 
<div class="grid text-center" style="--bs-columns: 4; --bs-gap: 5rem;">
+  <div class="g-col-2">.g-col-2</div>
+  <div class="g-col-2">.g-col-2</div>
+</div>
+ +
+
+
.g-col-6
+
.g-col-4
+
+
+ html +
+ + +
+ 
<div class="grid text-center" style="--bs-columns: 10; --bs-gap: 1rem;">
+  <div class="g-col-6">.g-col-6</div>
+  <div class="g-col-4">.g-col-4</div>
+</div>
+ +

Adding rows

+

Adding more rows and changing the placement of columns:

+
+
+
Auto-column
+
Auto-column
+
Auto-column
+
+
+ html +
+ + +
+ 
<div class="grid text-center" style="--bs-rows: 3; --bs-columns: 3;">
+  <div>Auto-column</div>
+  <div class="g-start-2" style="grid-row: 2">Auto-column</div>
+  <div class="g-start-3" style="grid-row: 3">Auto-column</div>
+</div>
+ +

Gaps

+

Change the vertical gaps only by modifying the row-gap. Note that we use gap on .grids, but row-gap and column-gap can be modified as needed.

+
+
+
.g-col-6
+
.g-col-6
+ +
.g-col-6
+
.g-col-6
+
+
+ html +
+ + +
+ 
<div class="grid text-center" style="row-gap: 0;">
+  <div class="g-col-6">.g-col-6</div>
+  <div class="g-col-6">.g-col-6</div>
+
+  <div class="g-col-6">.g-col-6</div>
+  <div class="g-col-6">.g-col-6</div>
+</div>
+ +

Because of that, you can have different vertical and horizontal gaps, which can take a single value (all sides) or a pair of values (vertical and horizontal). This can be applied with an inline style for gap, or with our --bs-gap CSS variable.

+
+
+
.g-col-6
+
.g-col-6
+ +
.g-col-6
+
.g-col-6
+
+
+ html +
+ + +
+ 
<div class="grid text-center" style="--bs-gap: .25rem 1rem;">
+  <div class="g-col-6">.g-col-6</div>
+  <div class="g-col-6">.g-col-6</div>
+
+  <div class="g-col-6">.g-col-6</div>
+  <div class="g-col-6">.g-col-6</div>
+</div>
+ +

Sass

+

One limitation of the CSS Grid is that our default classes are still generated by two Sass variables, $grid-columns and $grid-gutter-width. This effectively predetermines the number of classes generated in our compiled CSS. You have two options here:

+
    +
  • Modify those default Sass variables and recompile your CSS.
    • +
  • Use inline or custom styles to augment the provided classes.
    • +
+

For example, you can increase the column count and change the gap size, and then size your “columns” with a mix of inline styles and predefined CSS Grid column classes (e.g., .g-col-4).

+
+
+
14 columns
+
.g-col-4
+
+
+ html +
+ + +
+ 
<div class="grid text-center" style="--bs-columns: 18; --bs-gap: .5rem;">
+  <div style="grid-column: span 14;">14 columns</div>
+  <div class="g-col-4">.g-col-4</div>
+</div>
+ + +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/layout/grid/index.html b/docs/5.3/layout/grid/index.html new file mode 100644 index 0000000000..b93c1b0119 --- /dev/null +++ b/docs/5.3/layout/grid/index.html @@ -0,0 +1,1532 @@ + + + + + + + + + + + + +Grid system · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Grid system

+
+

Use our powerful mobile-first flexbox grid to build layouts of all shapes and sizes thanks to a twelve column system, six default responsive tiers, Sass variables and mixins, and dozens of predefined classes.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Example

+

Bootstrap’s grid system uses a series of containers, rows, and columns to layout and align content. It’s built with flexbox and is fully responsive. Below is an example and an in-depth explanation for how the grid system comes together.

+
+New to or unfamiliar with flexbox? Read this CSS Tricks flexbox guide for background, terminology, guidelines, and code snippets. +
+ +
+
+
+
+ Column +
+
+ Column +
+
+ Column +
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col">
+      Column
+    </div>
+    <div class="col">
+      Column
+    </div>
+    <div class="col">
+      Column
+    </div>
+  </div>
+</div>
+ +

The above example creates three equal-width columns across all devices and viewports using our predefined grid classes. Those columns are centered in the page with the parent .container.

+

How it works

+

Breaking it down, here’s how the grid system comes together:

+
    +
  • +

    Our grid supports six responsive breakpoints. Breakpoints are based on min-width media queries, meaning they affect that breakpoint and all those above it (e.g., .col-sm-4 applies to sm, md, lg, xl, and xxl). This means you can control container and column sizing and behavior by each breakpoint.

    +
    • +
  • +

    Containers center and horizontally pad your content. Use .container for a responsive pixel width, .container-fluid for width: 100% across all viewports and devices, or a responsive container (e.g., .container-md) for a combination of fluid and pixel widths.

    +
    • +
  • +

    Rows are wrappers for columns. Each column has horizontal padding (called a gutter) for controlling the space between them. This padding is then counteracted on the rows with negative margins to ensure the content in your columns is visually aligned down the left side. Rows also support modifier classes to uniformly apply column sizing and gutter classes to change the spacing of your content.

    +
    • +
  • +

    Columns are incredibly flexible. There are 12 template columns available per row, allowing you to create different combinations of elements that span any number of columns. Column classes indicate the number of template columns to span (e.g., col-4 spans four). widths are set in percentages so you always have the same relative sizing.

    +
    • +
  • +

    Gutters are also responsive and customizable. Gutter classes are available across all breakpoints, with all the same sizes as our margin and padding spacing. Change horizontal gutters with .gx-* classes, vertical gutters with .gy-*, or all gutters with .g-* classes. .g-0 is also available to remove gutters.

    +
    • +
  • +

    Sass variables, maps, and mixins power the grid. If you don’t want to use the predefined grid classes in Bootstrap, you can use our grid’s source Sass to create your own with more semantic markup. We also include some CSS custom properties to consume these Sass variables for even greater flexibility for you.

    +
    • +
+

Be aware of the limitations and bugs around flexbox, like the inability to use some HTML elements as flex containers.

+

Grid options

+

Bootstrap’s grid system can adapt across all six default breakpoints, and any breakpoints you customize. The six default grid tiers are as follows:

+
    +
  • Extra small (xs)
    • +
  • Small (sm)
    • +
  • Medium (md)
    • +
  • Large (lg)
    • +
  • Extra large (xl)
    • +
  • Extra extra large (xxl)
    • +
+

As noted above, each of these breakpoints have their own container, unique class prefix, and modifiers. Here’s how the grid changes across these breakpoints:

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ xs
+ <576px + 		+ sm
+ ≥576px + 		+ md
+ ≥768px + 		+ lg
+ ≥992px + 		+ xl
+ ≥1200px + 		+ xxl
+ ≥1400px +
Container max-widthNone (auto)540px720px960px1140px1320px
Class prefix.col-.col-sm-.col-md-.col-lg-.col-xl-.col-xxl-
# of columns12
Gutter width1.5rem (.75rem on left and right)
Custom guttersYes
NestableYes
Column orderingYes
+
+

Auto-layout columns

+

Utilize breakpoint-specific column classes for easy column sizing without an explicit numbered class like .col-sm-6.

+

Equal-width

+

For example, here are two grid layouts that apply to every device and viewport, from xs to xxl. Add any number of unit-less classes for each breakpoint you need and every column will be the same width.

+
+
+
+
+ 1 of 2 +
+
+ 2 of 2 +
+
+
+
+ 1 of 3 +
+
+ 2 of 3 +
+
+ 3 of 3 +
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col">
+      1 of 2
+    </div>
+    <div class="col">
+      2 of 2
+    </div>
+  </div>
+  <div class="row">
+    <div class="col">
+      1 of 3
+    </div>
+    <div class="col">
+      2 of 3
+    </div>
+    <div class="col">
+      3 of 3
+    </div>
+  </div>
+</div>
+ +

Setting one column width

+

Auto-layout for flexbox grid columns also means you can set the width of one column and have the sibling columns automatically resize around it. You may use predefined grid classes (as shown below), grid mixins, or inline widths. Note that the other columns will resize no matter the width of the center column.

+
+
+
+
+ 1 of 3 +
+
+ 2 of 3 (wider) +
+
+ 3 of 3 +
+
+
+
+ 1 of 3 +
+
+ 2 of 3 (wider) +
+
+ 3 of 3 +
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col">
+      1 of 3
+    </div>
+    <div class="col-6">
+      2 of 3 (wider)
+    </div>
+    <div class="col">
+      3 of 3
+    </div>
+  </div>
+  <div class="row">
+    <div class="col">
+      1 of 3
+    </div>
+    <div class="col-5">
+      2 of 3 (wider)
+    </div>
+    <div class="col">
+      3 of 3
+    </div>
+  </div>
+</div>
+ +

Variable width content

+

Use col-{breakpoint}-auto classes to size columns based on the natural width of their content.

+
+
+
+
+ 1 of 3 +
+
+ Variable width content +
+
+ 3 of 3 +
+
+
+
+ 1 of 3 +
+
+ Variable width content +
+
+ 3 of 3 +
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row justify-content-md-center">
+    <div class="col col-lg-2">
+      1 of 3
+    </div>
+    <div class="col-md-auto">
+      Variable width content
+    </div>
+    <div class="col col-lg-2">
+      3 of 3
+    </div>
+  </div>
+  <div class="row">
+    <div class="col">
+      1 of 3
+    </div>
+    <div class="col-md-auto">
+      Variable width content
+    </div>
+    <div class="col col-lg-2">
+      3 of 3
+    </div>
+  </div>
+</div>
+ +

Responsive classes

+

Bootstrap’s grid includes six tiers of predefined classes for building complex responsive layouts. Customize the size of your columns on extra small, small, medium, large, or extra large devices however you see fit.

+

All breakpoints

+

For grids that are the same from the smallest of devices to the largest, use the .col and .col-* classes. Specify a numbered class when you need a particularly sized column; otherwise, feel free to stick to .col.

+
+
+
+
col
+
col
+
col
+
col
+
+
+
col-8
+
col-4
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col">col</div>
+    <div class="col">col</div>
+    <div class="col">col</div>
+    <div class="col">col</div>
+  </div>
+  <div class="row">
+    <div class="col-8">col-8</div>
+    <div class="col-4">col-4</div>
+  </div>
+</div>
+ +

Stacked to horizontal

+

Using a single set of .col-sm-* classes, you can create a basic grid system that starts out stacked and becomes horizontal at the small breakpoint (sm).

+
+
+
+
col-sm-8
+
col-sm-4
+
+
+
col-sm
+
col-sm
+
col-sm
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col-sm-8">col-sm-8</div>
+    <div class="col-sm-4">col-sm-4</div>
+  </div>
+  <div class="row">
+    <div class="col-sm">col-sm</div>
+    <div class="col-sm">col-sm</div>
+    <div class="col-sm">col-sm</div>
+  </div>
+</div>
+ +

Mix and match

+

Don’t want your columns to simply stack in some grid tiers? Use a combination of different classes for each tier as needed. See the example below for a better idea of how it all works.

+
+
+ +
+
.col-md-8
+
.col-6 .col-md-4
+
+ + +
+
.col-6 .col-md-4
+
.col-6 .col-md-4
+
.col-6 .col-md-4
+
+ + +
+
.col-6
+
.col-6
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <!-- Stack the columns on mobile by making one full-width and the other half-width -->
+  <div class="row">
+    <div class="col-md-8">.col-md-8</div>
+    <div class="col-6 col-md-4">.col-6 .col-md-4</div>
+  </div>
+
+  <!-- Columns start at 50% wide on mobile and bump up to 33.3% wide on desktop -->
+  <div class="row">
+    <div class="col-6 col-md-4">.col-6 .col-md-4</div>
+    <div class="col-6 col-md-4">.col-6 .col-md-4</div>
+    <div class="col-6 col-md-4">.col-6 .col-md-4</div>
+  </div>
+
+  <!-- Columns are always 50% wide, on mobile and desktop -->
+  <div class="row">
+    <div class="col-6">.col-6</div>
+    <div class="col-6">.col-6</div>
+  </div>
+</div>
+ +

Row columns

+

Use the responsive .row-cols-* classes to quickly set the number of columns that best render your content and layout. Whereas normal .col-* classes apply to the individual columns (e.g., .col-md-4), the row columns classes are set on the parent .row as a shortcut. With .row-cols-auto you can give the columns their natural width.

+

Use these row columns classes to quickly create basic grid layouts or to control your card layouts.

+
+
+
+
Column
+
Column
+
Column
+
Column
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row row-cols-2">
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+  </div>
+</div>
+ +
+
+
+
Column
+
Column
+
Column
+
Column
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row row-cols-3">
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+  </div>
+</div>
+ +
+
+
+
Column
+
Column
+
Column
+
Column
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row row-cols-auto">
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+  </div>
+</div>
+ +
+
+
+
Column
+
Column
+
Column
+
Column
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row row-cols-4">
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+  </div>
+</div>
+ +
+
+
+
Column
+
Column
+
Column
+
Column
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row row-cols-4">
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+    <div class="col-6">Column</div>
+    <div class="col">Column</div>
+  </div>
+</div>
+ +
+
+
+
Column
+
Column
+
Column
+
Column
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row row-cols-1 row-cols-sm-2 row-cols-md-4">
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+    <div class="col">Column</div>
+  </div>
+</div>
+ +

You can also use the accompanying Sass mixin, row-cols():

+
.element {
+  // Three columns to start
+  @include row-cols(3);
+
+  // Five columns from medium breakpoint up
+  @include media-breakpoint-up(md) {
+    @include row-cols(5);
+  }
+}
+

Nesting

+

To nest your content with the default grid, add a new .row and set of .col-sm-* columns within an existing .col-sm-* column. Nested rows should include a set of columns that add up to 12 or fewer (it is not required that you use all 12 available columns).

+
+
+
+
+ Level 1: .col-sm-3 +
+
+
+
+ Level 2: .col-8 .col-sm-6 +
+
+ Level 2: .col-4 .col-sm-6 +
+
+
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row">
+    <div class="col-sm-3">
+      Level 1: .col-sm-3
+    </div>
+    <div class="col-sm-9">
+      <div class="row">
+        <div class="col-8 col-sm-6">
+          Level 2: .col-8 .col-sm-6
+        </div>
+        <div class="col-4 col-sm-6">
+          Level 2: .col-4 .col-sm-6
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+ +

Sass

+

When using Bootstrap’s source Sass files, you have the option of using Sass variables and mixins to create custom, semantic, and responsive page layouts. Our predefined grid classes use these same variables and mixins to provide a whole suite of ready-to-use classes for fast responsive layouts.

+

Variables

+

Variables and maps determine the number of columns, the gutter width, and the media query point at which to begin floating columns. We use these to generate the predefined grid classes documented above, as well as for the custom mixins listed below.

+
$grid-columns:      12;
+$grid-gutter-width: 1.5rem;
+$grid-row-columns:  6;
+
$grid-breakpoints: (
+  xs: 0,
+  sm: 576px,
+  md: 768px,
+  lg: 992px,
+  xl: 1200px,
+  xxl: 1400px
+);
+
+
$container-max-widths: (
+  sm: 540px,
+  md: 720px,
+  lg: 960px,
+  xl: 1140px,
+  xxl: 1320px
+);
+
+

Mixins

+

Mixins are used in conjunction with the grid variables to generate semantic CSS for individual grid columns.

+
// Creates a wrapper for a series of columns
+@include make-row();
+
+// Make the element grid-ready (applying everything but the width)
+@include make-col-ready();
+
+// Without optional size values, the mixin will create equal columns (similar to using .col)
+@include make-col();
+@include make-col($size, $columns: $grid-columns);
+
+// Offset with margins
+@include make-col-offset($size, $columns: $grid-columns);
+

Example usage

+

You can modify the variables to your own custom values, or just use the mixins with their default values. Here’s an example of using the default settings to create a two-column layout with a gap between.

+
.example-container {
+  @include make-container();
+  // Make sure to define this width after the mixin to override
+  // `width: 100%` generated by `make-container()`
+  width: 800px;
+}
+
+.example-row {
+  @include make-row();
+}
+
+.example-content-main {
+  @include make-col-ready();
+
+  @include media-breakpoint-up(sm) {
+    @include make-col(6);
+  }
+  @include media-breakpoint-up(lg) {
+    @include make-col(8);
+  }
+}
+
+.example-content-secondary {
+  @include make-col-ready();
+
+  @include media-breakpoint-up(sm) {
+    @include make-col(6);
+  }
+  @include media-breakpoint-up(lg) {
+    @include make-col(4);
+  }
+}
+
+
+
+
Main content
+
Secondary content
+
+
+
+ html +
+ + +
+ 
<div class="example-container">
+  <div class="example-row">
+    <div class="example-content-main">Main content</div>
+    <div class="example-content-secondary">Secondary content</div>
+  </div>
+</div>
+ +

Customizing the grid

+

Using our built-in grid Sass variables and maps, it’s possible to completely customize the predefined grid classes. Change the number of tiers, the media query dimensions, and the container widths—then recompile.

+

Columns and gutters

+

The number of grid columns can be modified via Sass variables. $grid-columns is used to generate the widths (in percent) of each individual column while $grid-gutter-width sets the width for the column gutters. $grid-row-columns is used to set the maximum number of columns of .row-cols-*, any number over this limit is ignored.

+
$grid-columns: 12 !default;
+$grid-gutter-width: 1.5rem !default;
+$grid-row-columns: 6 !default;
+

Grid tiers

+

Moving beyond the columns themselves, you may also customize the number of grid tiers. If you wanted just four grid tiers, you’d update the $grid-breakpoints and $container-max-widths to something like this:

+
$grid-breakpoints: (
+  xs: 0,
+  sm: 480px,
+  md: 768px,
+  lg: 1024px
+);
+
+$container-max-widths: (
+  sm: 420px,
+  md: 720px,
+  lg: 960px
+);
+

When making any changes to the Sass variables or maps, you’ll need to save your changes and recompile. Doing so will output a brand-new set of predefined grid classes for column widths, offsets, and ordering. Responsive visibility utilities will also be updated to use the custom breakpoints. Make sure to set grid values in px (not rem, em, or %).

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/layout/gutters/index.html b/docs/5.3/layout/gutters/index.html new file mode 100644 index 0000000000..8af16b6183 --- /dev/null +++ b/docs/5.3/layout/gutters/index.html @@ -0,0 +1,984 @@ + + + + + + + + + + + + +Gutters · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Gutters

+
+

Gutters are the padding between your columns, used to responsively space and align content in the Bootstrap grid system.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

How they work

+
    +
  • +

    Gutters are the gaps between column content, created by horizontal padding. We set padding-right and padding-left on each column, and use negative margin to offset that at the start and end of each row to align content.

    +
    • +
  • +

    Gutters start at 1.5rem (24px) wide. This allows us to match our grid to the padding and margin spacers scale.

    +
    • +
  • +

    Gutters can be responsively adjusted. Use breakpoint-specific gutter classes to modify horizontal gutters, vertical gutters, and all gutters.

    +
    • +
+

Horizontal gutters

+

.gx-* classes can be used to control the horizontal gutter widths. The .container or .container-fluid parent may need to be adjusted if larger gutters are used too to avoid unwanted overflow, using a matching padding utility. For example, in the following example we’ve increased the padding with .px-4:

+
+
+
+
+
Custom column padding
+
+
+
Custom column padding
+
+
+
+
+ html +
+ + +
+ 
<div class="container px-4 text-center">
+  <div class="row gx-5">
+    <div class="col">
+     <div class="p-3">Custom column padding</div>
+    </div>
+    <div class="col">
+      <div class="p-3">Custom column padding</div>
+    </div>
+  </div>
+</div>
+ +

An alternative solution is to add a wrapper around the .row with the .overflow-hidden class:

+
+
+
+
+
Custom column padding
+
+
+
Custom column padding
+
+
+
+
+ html +
+ + +
+ 
<div class="container overflow-hidden text-center">
+  <div class="row gx-5">
+    <div class="col">
+     <div class="p-3">Custom column padding</div>
+    </div>
+    <div class="col">
+      <div class="p-3">Custom column padding</div>
+    </div>
+  </div>
+</div>
+ +

Vertical gutters

+

.gy-* classes can be used to control the vertical gutter widths within a row when columns wrap to new lines. Like the horizontal gutters, the vertical gutters can cause some overflow below the .row at the end of a page. If this occurs, you add a wrapper around .row with the .overflow-hidden class:

+
+
+
+
+
Custom column padding
+
+
+
Custom column padding
+
+
+
Custom column padding
+
+
+
Custom column padding
+
+
+
+
+ html +
+ + +
+ 
<div class="container overflow-hidden text-center">
+  <div class="row gy-5">
+    <div class="col-6">
+      <div class="p-3">Custom column padding</div>
+    </div>
+    <div class="col-6">
+      <div class="p-3">Custom column padding</div>
+    </div>
+    <div class="col-6">
+      <div class="p-3">Custom column padding</div>
+    </div>
+    <div class="col-6">
+      <div class="p-3">Custom column padding</div>
+    </div>
+  </div>
+</div>
+ +

Horizontal & vertical gutters

+

.g-* classes can be used to control the horizontal gutter widths, for the following example we use a smaller gutter width, so there won’t be a need to add the .overflow-hidden wrapper class.

+
+
+
+
+
Custom column padding
+
+
+
Custom column padding
+
+
+
Custom column padding
+
+
+
Custom column padding
+
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row g-2">
+    <div class="col-6">
+      <div class="p-3">Custom column padding</div>
+    </div>
+    <div class="col-6">
+      <div class="p-3">Custom column padding</div>
+    </div>
+    <div class="col-6">
+      <div class="p-3">Custom column padding</div>
+    </div>
+    <div class="col-6">
+      <div class="p-3">Custom column padding</div>
+    </div>
+  </div>
+</div>
+ +

Row columns gutters

+

Gutter classes can also be added to row columns. In the following example, we use responsive row columns and responsive gutter classes.

+
+
+
+
+
Row column
+
+
+
Row column
+
+
+
Row column
+
+
+
Row column
+
+
+
Row column
+
+
+
Row column
+
+
+
Row column
+
+
+
Row column
+
+
+
Row column
+
+
+
Row column
+
+
+
+
+ html +
+ + +
+ 
<div class="container text-center">
+  <div class="row row-cols-2 row-cols-lg-5 g-2 g-lg-3">
+    <div class="col">
+      <div class="p-3">Row column</div>
+    </div>
+    <div class="col">
+      <div class="p-3">Row column</div>
+    </div>
+    <div class="col">
+      <div class="p-3">Row column</div>
+    </div>
+    <div class="col">
+      <div class="p-3">Row column</div>
+    </div>
+    <div class="col">
+      <div class="p-3">Row column</div>
+    </div>
+    <div class="col">
+      <div class="p-3">Row column</div>
+    </div>
+    <div class="col">
+      <div class="p-3">Row column</div>
+    </div>
+    <div class="col">
+      <div class="p-3">Row column</div>
+    </div>
+    <div class="col">
+      <div class="p-3">Row column</div>
+    </div>
+    <div class="col">
+      <div class="p-3">Row column</div>
+    </div>
+  </div>
+</div>
+ +

No gutters

+

The gutters between columns in our predefined grid classes can be removed with .g-0. This removes the negative margins from .row and the horizontal padding from all immediate children columns.

+

Need an edge-to-edge design? Drop the parent .container or .container-fluid and add .mx-0 to the .row to prevent overflow.

+

In practice, here’s how it looks. Note you can continue to use this with all other predefined grid classes (including column widths, responsive tiers, reorders, and more).

+
+
+
.col-sm-6 .col-md-8
+
.col-6 .col-md-4
+
+
+ html +
+ + +
+ 
<div class="row g-0 text-center">
+  <div class="col-sm-6 col-md-8">.col-sm-6 .col-md-8</div>
+  <div class="col-6 col-md-4">.col-6 .col-md-4</div>
+</div>
+ +

Change the gutters

+

Classes are built from the $gutters Sass map which is inherited from the $spacers Sass map.

+
$grid-gutter-width: 1.5rem;
+$gutters: (
+  0: 0,
+  1: $spacer * .25,
+  2: $spacer * .5,
+  3: $spacer,
+  4: $spacer * 1.5,
+  5: $spacer * 3,
+);
+
+
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/layout/index.html b/docs/5.3/layout/index.html new file mode 100644 index 0000000000..afc1eb735a --- /dev/null +++ b/docs/5.3/layout/index.html @@ -0,0 +1,12 @@ + + + + + + https://getbootstrap.com/docs/5.3/layout/breakpoints/ + + + + + + diff --git a/docs/5.3/layout/utilities/index.html b/docs/5.3/layout/utilities/index.html new file mode 100644 index 0000000000..ed92b92c4f --- /dev/null +++ b/docs/5.3/layout/utilities/index.html @@ -0,0 +1,702 @@ + + + + + + + + + + + + +Utilities for layout · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Utilities for layout

+
+

For faster mobile-friendly and responsive development, Bootstrap includes dozens of utility classes for showing, hiding, aligning, and spacing content.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Changing display

+

Use our display utilities for responsively toggling common values of the display property. Mix it with our grid system, content, or components to show or hide them across specific viewports.

+

Flexbox options

+

Bootstrap is built with flexbox, but not every element’s display has been changed to display: flex as this would add many unnecessary overrides and unexpectedly change key browser behaviors. Most of our components are built with flexbox enabled.

+

Should you need to add display: flex to an element, do so with .d-flex or one of the responsive variants (e.g., .d-sm-flex). You’ll need this class or display value to allow the use of our extra flexbox utilities for sizing, alignment, spacing, and more.

+

Margin and padding

+

Use the margin and padding spacing utilities to control how elements and components are spaced and sized. Bootstrap includes a six-level scale for spacing utilities, based on a 1rem value default $spacer variable. Choose values for all viewports (e.g., .me-3 for margin-right: 1rem in LTR), or pick responsive variants to target specific viewports (e.g., .me-md-3 for margin-right: 1rem —in LTR— starting at the md breakpoint).

+

Toggle visibility

+

When toggling display isn’t needed, you can toggle the visibility of an element with our visibility utilities. Invisible elements will still affect the layout of the page, but are visually hidden from visitors.

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/layout/z-index/index.html b/docs/5.3/layout/z-index/index.html new file mode 100644 index 0000000000..a3a053fe6f --- /dev/null +++ b/docs/5.3/layout/z-index/index.html @@ -0,0 +1,689 @@ + + + + + + + + + + + + +Z-index · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Z-index

+
+

While not a part of Bootstrap’s grid system, z-indexes play an important part in how our components overlay and interact with one another.

+ + +
+ + + +
+ + +

Several Bootstrap components utilize z-index, the CSS property that helps control layout by providing a third axis to arrange content. We utilize a default z-index scale in Bootstrap that’s been designed to properly layer navigation, tooltips and popovers, modals, and more.

+

These higher values start at an arbitrary number, high and specific enough to ideally avoid conflicts. We need a standard set of these across our layered components—tooltips, popovers, navbars, dropdowns, modals—so we can be reasonably consistent in the behaviors. There’s no reason we couldn’t have used 100+ or 500+.

+

We don’t encourage customization of these individual values; should you change one, you likely need to change them all.

+
$zindex-dropdown:                   1000;
+$zindex-sticky:                     1020;
+$zindex-fixed:                      1030;
+$zindex-offcanvas-backdrop:         1040;
+$zindex-offcanvas:                  1045;
+$zindex-modal-backdrop:             1050;
+$zindex-modal:                      1055;
+$zindex-popover:                    1070;
+$zindex-tooltip:                    1080;
+$zindex-toast:                      1090;
+
+

To handle overlapping borders within components (e.g., buttons and inputs in input groups), we use low single digit z-index values of 1, 2, and 3 for default, hover, and active states. On hover/focus/active, we bring a particular element to the forefront with a higher z-index value to show their border over the sibling elements.

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/migration/index.html b/docs/5.3/migration/index.html new file mode 100644 index 0000000000..6096484eb9 --- /dev/null +++ b/docs/5.3/migration/index.html @@ -0,0 +1,1545 @@ + + + + + + + + + + + + +Migrating to v5 · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Migrating to v5

+
+

Track and review changes to the Bootstrap source files, documentation, and components to help you migrate from v4 to v5.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

v5.3.0

+
+

Color modes!

+

Learn more by reading the new color modes documentation.

+
    +
  • +

    Global support for light (default) and dark color modes. Set color mode globally on the :root element, on groups of elements and components with a wrapper class, or directly on components, with data-bs-theme="light|dark". Also included is a new color-mode() mixin that can output a ruleset with the data-bs-theme selector or a media query, depending on your preference.

    +

    Deprecated Color modes replace dark variants for components, so .btn-close-white, .carousel-dark, .dropdown-menu-dark, and .navbar-dark are deprecated.

    +
    • +
  • +

    New extended color system. We’ve added new theme colors (but not in $theme-colors)) for a more nuanced, system-wide color palette with new secondary, tertiary, and emphasis colors for color and background-color. These new colors are available as Sass variables, CSS variables, and utilities.

    +
    • +
  • +

    We’ve also expanded our theme color Sass variables, CSS variables, and utilities to include text emphasis, subtle background colors, and subtle border colors. These are available as Sass variables, CSS variables, and utilities.

    +
    • +
  • +

    Adds new _variables-dark.scss stylesheet to house dark-mode specific overrides. This stylesheet should be imported immediately after the existing _variables.scss file in your import stack.

    +
    diff --git a/scss/bootstrap.scss b/scss/bootstrap.scss
+index 8f8296def..449d70487 100644
+--- a/scss/bootstrap.scss
++++ b/scss/bootstrap.scss
+@@ -6,6 +6,7 @@
+ // Configuration
+ @import "functions";
+ @import "variables";
++@import "variables-dark";
+ @import "maps";
+ @import "mixins";
+ @import "utilities";
+
    • +
+

CSS variables

+
    +
  • +

    Restores CSS variables for breakpoints, though we don’t use them in our media queries as they’re not supported. However, these can be useful in JS-specific contexts.

    +
    • +
  • +

    Per the color modes update, we’ve added new utilities for new Sass CSS variables secondary and tertiary text and background colors, plus {color}-bg-subtle, {color}-border-subtle, and {color}-text for our theme colors. These new colors are available through Sass and CSS variables (but not our color maps) with the express goal of making it easier to customize across multiple colors modes like light and dark.

    +
    • +
  • +

    Adds additional variables for alerts, .btn-close, and .offcanvas.

    +
    • +
  • +

    The --bs-heading-color variable is back with an update and dark mode support. First, we now check for a null value on the associated Sass variable, $headings-color, before trying to output the CSS variable, so by default it’s not present in our compiled CSS. Second, we use the CSS variable with a fallback value, inherit, allowing the original behavior to persist, but also allowing for overrides.

    +
    • +
  • +

    Converts links to use CSS variables for styling color, but not text-decoration. Colors are now set with --bs-link-color-rgb and --bs-link-opacity as rgba() color, allowing you to customize the translucency with ease. The a:hover pseudo-class now overrides --bs-link-color-rgb instead of explicitly setting the color property.

    +
    • +
  • +

    --bs-border-width is now being used in more components for greater control over default global styling.

    +
    • +
  • +

    Adds new root CSS variables for our box-shadows, including --bs-box-shadow, --bs-box-shadow-sm, --bs-box-shadow-lg, and --bs-box-shadow-inset.

    +
    • +
+

Components

+

Alert

+
    +
  • +

    Alert variants are now styled via CSS variables.

    +
    • +
  • +

    Deprecated The .alert-variant() mixin is now deprecated. We now use the Sass loop directly to modify the component’s default CSS variables for each variant.

    +
    • +
+

List group

+
    +
  • +

    List group item variants are now styled via CSS variables.

    +
    • +
  • +

    Deprecated The .list-group-variant() mixin is now deprecated. We now use the Sass loop directly to modify the component’s default CSS variables for each variant.

    +
    • +
+

Close button

+
    +
  • Deprecated The .btn-close-white class has been deprecated and replaced with data-bs-theme="dark" on the close button or any parent element. See the docs for an example.
    • +
+ + +

Progress bars

+

The markup for progress bars has been updated in v5.3.0. Due to the placement of role and various aria- attributes on the inner .progress-bar element, some screen readers were not announcing zero value progress bars. Now, role="progressbar" and the relevant aria-* attributes are on the outer .progress element, leaving the .progress-bar purely for the visual presentation of the bar and optional label.

+

While we recommend adopting the new markup for improved compatibility with all screen readers, note that the legacy progress bar structure will continue to work as before.

+
<!-- Previous markup -->
+<div class="progress">
+  <div class="progress-bar" role="progressbar" aria-label="Basic example" style="width: 25%" aria-valuenow="25" aria-valuemin="0" aria-valuemax="100"></div>
+</div>
+
+<!-- New markup -->
+<div class="progress" role="progressbar" aria-label="Basic example" aria-valuenow="25" aria-valuemin="0" aria-valuemax="100">
+  <div class="progress-bar" style="width: 25%"></div>
+</div>
+

We’ve also introduced a new .progress-stacked class to more logically wrap multiple progress bars into a single stacked progress bar.

+
<!-- Previous markup -->
+<div class="progress">
+  <div class="progress-bar" role="progressbar" aria-label="Segment one" style="width: 15%" aria-valuenow="15" aria-valuemin="0" aria-valuemax="100"></div>
+  <div class="progress-bar bg-success" role="progressbar" aria-label="Segment two" style="width: 30%" aria-valuenow="30" aria-valuemin="0" aria-valuemax="100"></div>
+  <div class="progress-bar bg-info" role="progressbar" aria-label="Segment three" style="width: 20%" aria-valuenow="20" aria-valuemin="0" aria-valuemax="100"></div>
+</div>
+
+<!-- New markup -->
+<div class="progress-stacked">
+  <div class="progress" role="progressbar" aria-label="Segment one" aria-valuenow="15" aria-valuemin="0" aria-valuemax="100" style="width: 15%">
+    <div class="progress-bar"></div>
+  </div>
+  <div class="progress" role="progressbar" aria-label="Segment two" aria-valuenow="30" aria-valuemin="0" aria-valuemax="100" style="width: 30%">
+    <div class="progress-bar bg-success"></div>
+  </div>
+  <div class="progress" role="progressbar" aria-label="Segment three" aria-valuenow="20" aria-valuemin="0" aria-valuemax="100" style="width: 20%">
+    <div class="progress-bar bg-info"></div>
+  </div>
+</div>
+

Forms

+
    +
  • +

    .form-control is now styled with CSS variables to support color modes. This includes the addition of two new root CSS variables for the default and disabled form control backgrounds.

    +
    • +
  • +

    .form-check and .form-switch components are now built with CSS variables for setting the background-image. The usage here differs from other components in that the various focus, active, etc states for each component aren’t set on the base class. Instead, the states override one variable (e.g., --bs-form-switch-bg).

    +
    • +
  • +

    Floating form labels now have a background-color to fix support for <textarea> elements. Additional changes have been made to also support disabled states and more.

    +
    • +
  • +

    Fixed display of date and time inputs in WebKit based browsers.

    +
    • +
+

Utilities

+
    +
  • +

    Deprecated .text-muted will be be replaced by .text-body-secondary in v6.

    +

    With the addition of the expanded theme colors and variables, the .text-muted variables and utility have been deprecated with v5.3.0. Its default value has also has been reassigned to the new --bs-secondary-color CSS variable to better support color modes. It will be removed in v6.0.0.

    +
    • +
  • +

    Adds new .overflow-x, .overflow-y, and several .object-fit-* utilities. The object-fit property is used to specify how an <img> or <video> should be resized to fit its container, giving us a responsive alternative to using background-image for a resizable fill/fit image.

    +
    • +
  • +

    Adds new .fw-medium utility.

    +
    • +
  • +

    Added new .z-* utilities for z-index.

    +
    • +
  • +

    Box shadow utilities (and Sass variables) have been updated for dark mode. They now use --bs-body-color-rgb to generate the rgba() color values, allowing them to easily adapt to color modes based on the specified foreground color.

    +
    • +
+

For a complete list of changes, see the v5.3.0 project on GitHub.

+

v5.2.0

+
+

Refreshed design

+

Bootstrap v5.2.0 features a subtle design update for a handful of components and properties across the project, most notably through refined border-radius values on buttons and form controls. Our documentation also has been updated with a new homepage, simpler docs layout that no longer collapses sections of the sidebar, and more prominent examples of Bootstrap Icons.

+

More CSS variables

+

We’ve updated all our components to use CSS variables. While Sass still underpins everything, each component has been updated to include CSS variables on the component base classes (e.g., .btn), allowing for more real-time customization of Bootstrap. In subsequent releases, we’ll continue to expand our use of CSS variables into our layout, forms, helpers, and utilities. Read more about CSS variables in each component on their respective documentation pages.

+

Our CSS variable usage will be somewhat incomplete until Bootstrap 6. While we’d love to fully implement these across the board, they do run the risk of causing breaking changes. For example, setting $alert-border-width: var(--bs-border-width) in our source code breaks potential Sass in your own code if you were doing $alert-border-width * 2 for some reason.

+

As such, wherever possible, we will continue to push towards more CSS variables, but please recognize our implementation may be slightly limited in v5.

+

New _maps.scss

+

Bootstrap v5.2.0 introduced a new Sass file with _maps.scss. It pulls out several Sass maps from _variables.scss to fix an issue where updates to an original map were not applied to secondary maps that extend them. For example, updates to $theme-colors were not being applied to other theme maps that relied on $theme-colors, breaking key customization workflows. In short, Sass has a limitation where once a default variable or map has been used, it cannot be updated. There’s a similar shortcoming with CSS variables when they’re used to compose other CSS variables.

+

This is why variable customizations in Bootstrap have to come after @import "functions", but before @import "variables" and the rest of our import stack. The same applies to Sass maps—you must override the defaults before they get used. The following maps have been moved to the new _maps.scss:

+
    +
  • $theme-colors-rgb
    • +
  • $utilities-colors
    • +
  • $utilities-text
    • +
  • $utilities-text-colors
    • +
  • $utilities-bg
    • +
  • $utilities-bg-colors
    • +
  • $negative-spacers
    • +
  • $gutters
    • +
+

Your custom Bootstrap CSS builds should now look something like this with a separate maps import.

+
  // Functions come first
+  @import "functions";
+
+  // Optional variable overrides here
++ $custom-color: #df711b;
++ $custom-theme-colors: (
++   "custom": $custom-color
++ );
+
+  // Variables come next
+  @import "variables";
+
++ // Optional Sass map overrides here
++ $theme-colors: map-merge($theme-colors, $custom-theme-colors);
++
++ // Followed by our default maps
++ @import "maps";
++
+  // Rest of our imports
+  @import "mixins";
+  @import "utilities";
+  @import "root";
+  @import "reboot";
+  // etc
+

New utilities

+ +

Additional changes

+
    +
  • +

    Introduced new $enable-container-classes option. — Now when opting into the experimental CSS Grid layout, .container-* classes will still be compiled, unless this option is set to false. Containers also now keep their gutter values.

    +
    • +
  • +

    Offcanvas component now has responsive variations. The original .offcanvas class remains unchanged—it hides content across all viewports. To make it responsive, change that .offcanvas class to any .offcanvas-{sm|md|lg|xl|xxl} class.

    +
    • +
  • +

    Thicker table dividers are now opt-in. — We’ve removed the thicker and more difficult to override border between table groups and moved it to an optional class you can apply, .table-group-divider. See the table docs for an example.

    +
    • +
  • +

    Scrollspy has been rewritten to use the Intersection Observer API, which means you no longer need relative parent wrappers, deprecates offset config, and more. Look for your Scrollspy implementations to be more accurate and consistent in their nav highlighting.

    +
    • +
  • +

    Popovers and tooltips now use CSS variables. Some CSS variables have been updated from their Sass counterparts to reduce the number of variables. As a result, three variables have been deprecated in this release: $popover-arrow-color, $popover-arrow-outer-color, and $tooltip-arrow-color.

    +
    • +
  • +

    Added new .text-bg-{color} helpers. Instead of setting individual .text-* and .bg-* utilities, you can now use the .text-bg-* helpers to set a background-color with contrasting foreground color.

    +
    • +
  • +

    Added .form-check-reverse modifier to flip the order of labels and associated checkboxes/radios.

    +
    • +
  • +

    Added striped columns support to tables via the new .table-striped-columns class.

    +
    • +
+

For a complete list of changes, see the v5.2.0 project on GitHub.

+

v5.1.0

+
+
    +
  • +

    Added experimental support for CSS Grid layout. — This is a work in progress, and is not yet ready for production use, but you can opt into the new feature via Sass. To enable it, disable the default grid, by setting $enable-grid-classes: false and enable the CSS Grid by setting $enable-cssgrid: true.

    +
    • +
  • +

    Updated navbars to support offcanvas. — Add offcanvas drawers in any navbar with the responsive .navbar-expand-* classes and some offcanvas markup.

    +
    • +
  • +

    Added new placeholder component. — Our newest component, a way to provide temporary blocks in lieu of real content to help indicate that something is still loading in your site or app.

    +
    • +
  • +

    Collapse plugin now supports horizontal collapsing. — Add .collapse-horizontal to your .collapse to collapse the width instead of the height. Avoid browser repainting by setting a min-height or height.

    +
    • +
  • +

    Added new stack and vertical rule helpers. — Quickly apply multiple flexbox properties to quickly create custom layouts with stacks. Choose from horizontal (.hstack) and vertical (.vstack) stacks. Add vertical dividers similar to <hr> elements with the new .vr helpers.

    +
    • +
  • +

    Added new global :root CSS variables. — Added several new CSS variables to the :root level for controlling <body> styles. More are in the works, including across our utilities and components, but for now read up CSS variables in the Customize section.

    +
    • +
  • +

    Overhauled color and background utilities to use CSS variables, and added new text opacity and background opacity utilities. — .text-* and .bg-* utilities are now built with CSS variables and rgba() color values, allowing you to easily customize any utility with new opacity utilities.

    +
    • +
  • +

    Added new snippet examples based to show how to customize our components. — Pull ready to use customized components and other common design patterns with our new Snippets examples. Includes footers, dropdowns, list groups, and modals.

    +
    • +
  • +

    Removed unused positioning styles from popovers and tooltips as these are handled solely by Popper. $tooltip-margin has been deprecated and set to null in the process.

    +
    • +
+

Want more information? Read the v5.1.0 blog post.

+
+
+Hey there! Changes to our first major release of Bootstrap 5, v5.0.0, are documented below. They don’t reflect the additional changes shown above. +
+ +

Dependencies

+
    +
  • Dropped jQuery.
    • +
  • Upgraded from Popper v1.x to Popper v2.x.
    • +
  • Replaced Libsass with Dart Sass as our Sass compiler given Libsass was deprecated.
    • +
  • Migrated from Jekyll to Hugo for building our documentation
    • +
+

Browser support

+
    +
  • Dropped Internet Explorer 10 and 11
    • +
  • Dropped Microsoft Edge < 16 (Legacy Edge)
    • +
  • Dropped Firefox < 60
    • +
  • Dropped Safari < 12
    • +
  • Dropped iOS Safari < 12
    • +
  • Dropped Chrome < 60
    • +
+
+

Documentation changes

+
    +
  • Redesigned homepage, docs layout, and footer.
    • +
  • Added new Parcel guide.
    • +
  • Added new Customize section, replacing v4’s Theming page, with new details on Sass, global configuration options, color schemes, CSS variables, and more.
    • +
  • Reorganized all form documentation into new Forms section, breaking apart the content into more focused pages.
    • +
  • Similarly, updated the Layout section, to flesh out grid content more clearly.
    • +
  • Renamed “Navs” component page to “Navs & Tabs”.
    • +
  • Renamed “Checks” page to “Checks & radios”.
    • +
  • Redesigned the navbar and added a new subnav to make it easier to get around our sites and docs versions.
    • +
  • Added new keyboard shortcut for the search field: Ctrl + /.
    • +
+

Sass

+
    +
  • +

    We’ve ditched the default Sass map merges to make it easier to remove redundant values. Keep in mind you now have to define all values in the Sass maps like $theme-colors. Check out how to deal with Sass maps.

    +
    • +
  • +

    Breaking Renamed color-yiq() function and related variables to color-contrast() as it’s no longer related to YIQ color space. See #30168.

    +
      +
    • $yiq-contrasted-threshold is renamed to $min-contrast-ratio.
      • +
    • $yiq-text-dark and $yiq-text-light are respectively renamed to $color-contrast-dark and $color-contrast-light.
      • +
    +
    • +
  • +

    Breaking Media query mixins parameters have changed for a more logical approach.

    +
      +
    • media-breakpoint-down() uses the breakpoint itself instead of the next breakpoint (e.g., media-breakpoint-down(lg) instead of media-breakpoint-down(md) targets viewports smaller than lg).
      • +
    • Similarly, the second parameter in media-breakpoint-between() also uses the breakpoint itself instead of the next breakpoint (e.g., media-between(sm, lg) instead of media-breakpoint-between(sm, md) targets viewports between sm and lg).
      • +
    +
    • +
  • +

    Breaking Removed print styles and $enable-print-styles variable. Print display classes are still around. See #28339.

    +
    • +
  • +

    Breaking Dropped color(), theme-color(), and gray() functions in favor of variables. See #29083.

    +
    • +
  • +

    Breaking Renamed theme-color-level() function to color-level() and now accepts any color you want instead of only $theme-color colors. See #29083 Watch out: color-level() was later on dropped in v5.0.0-alpha3.

    +
    • +
  • +

    Breaking Renamed $enable-prefers-reduced-motion-media-query and $enable-pointer-cursor-for-buttons to $enable-reduced-motion and $enable-button-pointers for brevity.

    +
    • +
  • +

    Breaking Removed the bg-gradient-variant() mixin. Use the .bg-gradient class to add gradients to elements instead of the generated .bg-gradient-* classes.

    +
    • +
  • +

    Breaking Removed previously deprecated mixins:

    +
      +
    • hover, hover-focus, plain-hover-focus, and hover-focus-active
      • +
    • float()
      • +
    • form-control-mixin()
      • +
    • nav-divider()
      • +
    • retina-img()
      • +
    • text-hide() (also dropped the associated utility class, .text-hide)
      • +
    • visibility()
      • +
    • form-control-focus()
      • +
    +
    • +
  • +

    Breaking Renamed scale-color() function to shift-color() to avoid collision with Sass’s own color scaling function.

    +
    • +
  • +

    box-shadow mixins now allow null values and drop none from multiple arguments. See #30394.

    +
    • +
  • +

    The border-radius() mixin now has a default value.

    +
    • +
+

Color system

+
    +
  • +

    The color system which worked with color-level() and $theme-color-interval was removed in favor of a new color system. All lighten() and darken() functions in our codebase are replaced by tint-color() and shade-color(). These functions will mix the color with either white or black instead of changing its lightness by a fixed amount. The shift-color() will either tint or shade a color depending on whether its weight parameter is positive or negative. See #30622 for more details.

    +
    • +
  • +

    Added new tints and shades for every color, providing nine separate colors for each base color, as new Sass variables.

    +
    • +
  • +

    Improved color contrast. Bumped color contrast ratio from 3:1 to 4.5:1 and updated blue, green, cyan, and pink colors to ensure WCAG 2.1 AA contrast. Also changed our color contrast color from $gray-900 to $black.

    +
    • +
  • +

    To support our color system, we’ve added new custom tint-color() and shade-color() functions to mix our colors appropriately.

    +
    • +
+

Grid updates

+
    +
  • +

    New breakpoint! Added new xxl breakpoint for 1400px and up. No changes to all other breakpoints.

    +
    • +
  • +

    Improved gutters. Gutters are now set in rems, and are narrower than v4 (1.5rem, or about 24px, down from 30px). This aligns our grid system’s gutters with our spacing utilities.

    +
      +
    • Added new gutter class (.g-*, .gx-*, and .gy-*) to control horizontal/vertical gutters, horizontal gutters, and vertical gutters.
      • +
    • Breaking Renamed .no-gutters to .g-0 to match new gutter utilities.
      • +
    +
    • +
  • +

    Columns no longer have position: relative applied, so you may have to add .position-relative to some elements to restore that behavior.

    +
    • +
  • +

    Breaking Dropped several .order-* classes that often went unused. We now only provide .order-1 to .order-5 out of the box.

    +
    • +
  • +

    Breaking Dropped the .media component as it can be easily replicated with utilities. See #28265 and the flex utilities page for an example.

    +
    • +
  • +

    Breaking bootstrap-grid.css now only applies box-sizing: border-box to the column instead of resetting the global box-sizing. This way, our grid styles can be used in more places without interference.

    +
    • +
  • +

    $enable-grid-classes no longer disables the generation of container classes anymore. See #29146.

    +
    • +
  • +

    Updated the make-col mixin to default to equal columns without a specified size.

    +
    • +
+

Content, Reboot, etc

+
    +
  • +

    RFS is now enabled by default. Headings using the font-size() mixin will automatically adjust their font-size to scale with the viewport. This feature was previously opt-in with v4.

    +
    • +
  • +

    Breaking Overhauled our display typography to replace our $display-* variables and with a $display-font-sizes Sass map. Also removed the individual $display-*-weight variables for a single $display-font-weight and adjusted font-sizes.

    +
    • +
  • +

    Added two new .display-* heading sizes, .display-5 and .display-6.

    +
    • +
  • +

    Links are underlined by default (not just on hover), unless they’re part of specific components.

    +
    • +
  • +

    Redesigned tables to refresh their styles and rebuild them with CSS variables for more control over styling.

    +
    • +
  • +

    Breaking Nested tables do not inherit styles anymore.

    +
    • +
  • +

    Breaking .thead-light and .thead-dark are dropped in favor of the .table-* variant classes which can be used for all table elements (thead, tbody, tfoot, tr, th and td).

    +
    • +
  • +

    Breaking The table-row-variant() mixin is renamed to table-variant() and accepts only 2 parameters: $color (color name) and $value (color code). The border color and accent colors are automatically calculated based on the table factor variables.

    +
    • +
  • +

    Split table cell padding variables into -y and -x.

    +
    • +
  • +

    Breaking Dropped .pre-scrollable class. See #29135

    +
    • +
  • +

    Breaking .text-* utilities do not add hover and focus states to links anymore. .link-* helper classes can be used instead. See #29267

    +
    • +
  • +

    Breaking Dropped .text-justify class. See #29793

    +
    • +
  • +

    Breaking <hr> elements now use height instead of border to better support the size attribute. This also enables use of padding utilities to create thicker dividers (e.g., <hr class="py-1">).

    +
    • +
  • +

    Reset default horizontal padding-left on <ul> and <ol> elements from browser default 40px to 2rem.

    +
    • +
  • +

    Added $enable-smooth-scroll, which applies scroll-behavior: smooth globally—except for users asking for reduced motion through prefers-reduced-motion media query. See #31877

    +
    • +
+

RTL

+
    +
  • Horizontal direction specific variables, utilities, and mixins have all been renamed to use logical properties like those found in flexbox layouts—e.g., start and end in lieu of left and right.
    • +
+

Forms

+
    +
  • +

    Added new floating forms! We’ve promoted the Floating labels example to fully supported form components. See the new Floating labels page.

    +
    • +
  • +

    Breaking Consolidated native and custom form elements. Checkboxes, radios, selects, and other inputs that had native and custom classes in v4 have been consolidated. Now nearly all our form elements are entirely custom, most without the need for custom HTML.

    +
      +
    • .custom-control.custom-checkbox is now .form-check.
      • +
    • .custom-control.custom-custom-radio is now .form-check.
      • +
    • .custom-control.custom-switch is now .form-check.form-switch.
      • +
    • .custom-select is now .form-select.
      • +
    • .custom-file and .form-file have been replaced by custom styles on top of .form-control.
      • +
    • .custom-range is now .form-range.
      • +
    • Dropped native .form-control-file and .form-control-range.
      • +
    +
    • +
  • +

    Breaking Dropped .input-group-append and .input-group-prepend. You can now just add buttons and .input-group-text as direct children of the input groups.

    +
    • +
  • +

    The longstanding Missing border radius on input group with validation feedback bug is finally fixed by adding an additional .has-validation class to input groups with validation.

    +
    • +
  • +

    Breaking Dropped form-specific layout classes for our grid system. Use our grid and utilities instead of .form-group, .form-row, or .form-inline.

    +
    • +
  • +

    Breaking Form labels now require .form-label.

    +
    • +
  • +

    Breaking .form-text no longer sets display, allowing you to create inline or block help text as you wish just by changing the HTML element.

    +
    • +
  • +

    Form controls no longer used fixed height when possible, instead deferring to min-height to improve customization and compatibility with other components.

    +
    • +
  • +

    Validation icons are no longer applied to <select>s with multiple.

    +
    • +
  • +

    Rearranged source Sass files under scss/forms/, including input group styles.

    +
    • +
+
+

Components

+
    +
  • Unified padding values for alerts, breadcrumbs, cards, dropdowns, list groups, modals, popovers, and tooltips to be based on our $spacer variable. See #30564.
    • +
+

Accordion

+ +

Alerts

+
    +
  • +

    Alerts now have examples with icons.

    +
    • +
  • +

    Removed custom styles for <hr>s in each alert since they already use currentColor.

    +
    • +
+

Badges

+
    +
  • +

    Breaking Dropped all .badge-* color classes for background utilities (e.g., use .bg-primary instead of .badge-primary).

    +
    • +
  • +

    Breaking Dropped .badge-pill—use the .rounded-pill utility instead.

    +
    • +
  • +

    Breaking Removed hover and focus styles for <a> and <button> elements.

    +
    • +
  • +

    Increased default padding for badges from .25em/.5em to .35em/.65em.

    +
    • +
+ +
    +
  • +

    Simplified the default appearance of breadcrumbs by removing padding, background-color, and border-radius.

    +
    • +
  • +

    Added new CSS custom property --bs-breadcrumb-divider for easy customization without needing to recompile CSS.

    +
    • +
+

Buttons

+
    +
  • +

    Breaking Toggle buttons, with checkboxes or radios, no longer require JavaScript and have new markup. We no longer require a wrapping element, add .btn-check to the <input>, and pair it with any .btn classes on the <label>. See #30650. The docs for this has moved from our Buttons page to the new Forms section.

    +
    • +
  • +

    Breaking Dropped .btn-block for utilities. Instead of using .btn-block on the .btn, wrap your buttons with .d-grid and a .gap-* utility to space them as needed. Switch to responsive classes for even more control over them. Read the docs for some examples.

    +
    • +
  • +

    Updated our button-variant() and button-outline-variant() mixins to support additional parameters.

    +
    • +
  • +

    Updated buttons to ensure increased contrast on hover and active states.

    +
    • +
  • +

    Disabled buttons now have pointer-events: none;.

    +
    • +
+

Card

+
    +
  • +

    Breaking Dropped .card-deck in favor of our grid. Wrap your cards in column classes and add a parent .row-cols-* container to recreate card decks (but with more control over responsive alignment).

    +
    • +
  • +

    Breaking Dropped .card-columns in favor of Masonry. See #28922.

    +
    • +
  • +

    Breaking Replaced the .card based accordion with a new Accordion component.

    +
    • +
+ +
    +
  • +

    Added new .carousel-dark variant for dark text, controls, and indicators (great for lighter backgrounds).

    +
    • +
  • +

    Replaced chevron icons for carousel controls with new SVGs from Bootstrap Icons.

    +
    • +
+

Close button

+
    +
  • +

    Breaking Renamed .close to .btn-close for a less generic name.

    +
    • +
  • +

    Close buttons now use a background-image (embedded SVG) instead of a &times; in the HTML, allowing for easier customization without the need to touch your markup.

    +
    • +
  • +

    Added new .btn-close-white variant that uses filter: invert(1) to enable higher contrast dismiss icons against darker backgrounds.

    +
    • +
+

Collapse

+
    +
  • Removed scroll anchoring for accordions.
    • +
+ +
    +
  • +

    Added new .dropdown-menu-dark variant and associated variables for on-demand dark dropdowns.

    +
    • +
  • +

    Added new variable for $dropdown-padding-x.

    +
    • +
  • +

    Darkened the dropdown divider for improved contrast.

    +
    • +
  • +

    Breaking All the events for the dropdown are now triggered on the dropdown toggle button and then bubbled up to the parent element.

    +
    • +
  • +

    Dropdown menus now have a data-bs-popper="static" attribute set when the positioning of the dropdown is static, or dropdown is in the navbar. This is added by our JavaScript and helps us use custom position styles without interfering with Popper’s positioning.

    +
    • +
  • +

    Breaking Dropped flip option for dropdown plugin in favor of native Popper configuration. You can now disable the flipping behavior by passing an empty array for fallbackPlacements option in flip modifier.

    +
    • +
  • +

    Dropdown menus can now be clickable with a new autoClose option to handle the auto close behavior. You can use this option to accept the click inside or outside the dropdown menu to make it interactive.

    +
    • +
  • +

    Dropdowns now support .dropdown-items wrapped in <li>s.

    +
    • +
+

Jumbotron

+ +

List group

+ + +
    +
  • Added new null variables for font-size, font-weight, color, and :hover color to the .nav-link class.
    • +
+ +
    +
  • Breaking Navbars now require a container within (to drastically simplify spacing requirements and CSS required).
    • +
  • Breaking The .active class can no longer be applied to .nav-items, it must be applied directly on .nav-links.
    • +
+

Offcanvas

+ +

Pagination

+
    +
  • +

    Pagination links now have customizable margin-left that are dynamically rounded on all corners when separated from one another.

    +
    • +
  • +

    Added transitions to pagination links.

    +
    • +
+

Popovers

+
    +
  • +

    Breaking Renamed .arrow to .popover-arrow in our default popover template.

    +
    • +
  • +

    Renamed whiteList option to allowList.

    +
    • +
+

Spinners

+
    +
  • +

    Spinners now honor prefers-reduced-motion: reduce by slowing down animations. See #31882.

    +
    • +
  • +

    Improved spinner vertical alignment.

    +
    • +
+

Toasts

+
    +
  • +

    Toasts can now be positioned in a .toast-container with the help of positioning utilities.

    +
    • +
  • +

    Changed default toast duration to 5 seconds.

    +
    • +
  • +

    Removed overflow: hidden from toasts and replaced with proper border-radiuss with calc() functions.

    +
    • +
+

Tooltips

+
    +
  • +

    Breaking Renamed .arrow to .tooltip-arrow in our default tooltip template.

    +
    • +
  • +

    Breaking The default value for the fallbackPlacements is changed to ['top', 'right', 'bottom', 'left'] for better placement of popper elements.

    +
    • +
  • +

    Breaking Renamed whiteList option to allowList.

    +
    • +
+

Utilities

+
    +
  • +

    Breaking Renamed several utilities to use logical property names instead of directional names with the addition of RTL support:

    +
      +
    • Renamed .left-* and .right-* to .start-* and .end-*.
      • +
    • Renamed .float-left and .float-right to .float-start and .float-end.
      • +
    • Renamed .border-left and .border-right to .border-start and .border-end.
      • +
    • Renamed .rounded-left and .rounded-right to .rounded-start and .rounded-end.
      • +
    • Renamed .ml-* and .mr-* to .ms-* and .me-*.
      • +
    • Renamed .pl-* and .pr-* to .ps-* and .pe-*.
      • +
    • Renamed .text-left and .text-right to .text-start and .text-end.
      • +
    +
    • +
  • +

    Breaking Disabled negative margins by default.

    +
    • +
  • +

    Added new .bg-body class for quickly setting the <body>’s background to additional elements.

    +
    • +
  • +

    Added new position utilities for top, right, bottom, and left. Values include 0, 50%, and 100% for each property.

    +
    • +
  • +

    Added new .translate-middle-x & .translate-middle-y utilities to horizontally or vertically center absolute/fixed positioned elements.

    +
    • +
  • +

    Added new border-width utilities.

    +
    • +
  • +

    Breaking Renamed .text-monospace to .font-monospace.

    +
    • +
  • +

    Breaking Removed .text-hide as it’s an antiquated method for hiding text that shouldn’t be used anymore.

    +
    • +
  • +

    Added .fs-* utilities for font-size utilities (with RFS enabled). These use the same scale as HTML’s default headings (1-6, large to small), and can be modified via Sass map.

    +
    • +
  • +

    Breaking Renamed .font-weight-* utilities as .fw-* for brevity and consistency.

    +
    • +
  • +

    Breaking Renamed .font-italic utility to .fst-italic for brevity and consistency with new .fst-normal utility.

    +
    • +
  • +

    Added .d-grid to display utilities and new gap utilities (.gap) for CSS Grid and flexbox layouts.

    +
    • +
  • +

    Breaking Removed .rounded-sm and rounded-lg, and introduced a new scale of classes, .rounded-0 to .rounded-3. See #31687.

    +
    • +
  • +

    Added new line-height utilities: .lh-1, .lh-sm, .lh-base and .lh-lg. See here.

    +
    • +
  • +

    Moved the .d-none utility in our CSS to give it more weight over other display utilities.

    +
    • +
  • +

    Extended the .visually-hidden-focusable helper to also work on containers, using :focus-within.

    +
    • +
+

Helpers

+
    +
  • +

    Breaking Responsive embed helpers have been renamed to ratio helpers with new class names and improved behaviors, as well as a helpful CSS variable.

    +
      +
    • Classes have been renamed to change by to x in the aspect ratio. For example, .ratio-16by9 is now .ratio-16x9.
      • +
    • We’ve dropped the .embed-responsive-item and element group selector in favor of a simpler .ratio > * selector. No more class is needed, and the ratio helper now works with any HTML element.
      • +
    • The $embed-responsive-aspect-ratios Sass map has been renamed to $aspect-ratios and its values have been simplified to include the class name and the percentage as the key: value pair.
      • +
    • CSS variables are now generated and included for each value in the Sass map. Modify the --bs-aspect-ratio variable on the .ratio to create any custom aspect ratio.
      • +
    +
    • +
  • +

    Breaking “Screen reader” classes are now “visually hidden” classes.

    +
      +
    • Changed the Sass file from scss/helpers/_screenreaders.scss to scss/helpers/_visually-hidden.scss
      • +
    • Renamed .sr-only and .sr-only-focusable to .visually-hidden and .visually-hidden-focusable
      • +
    • Renamed sr-only() and sr-only-focusable() mixins to visually-hidden() and visually-hidden-focusable().
      • +
    +
    • +
  • +

    bootstrap-utilities.css now also includes our helpers. Helpers don’t need to be imported in custom builds anymore.

    +
    • +
+

JavaScript

+
    +
  • +

    Dropped jQuery dependency and rewrote plugins to be in regular JavaScript.

    +
    • +
  • +

    Breaking Data attributes for all JavaScript plugins are now namespaced to help distinguish Bootstrap functionality from third parties and your own code. For example, we use data-bs-toggle instead of data-toggle.

    +
    • +
  • +

    All plugins can now accept a CSS selector as the first argument. You can either pass a DOM element or any valid CSS selector to create a new instance of the plugin:

    +
    const modal = new bootstrap.Modal('#myModal')
+const dropdown = new bootstrap.Dropdown('[data-bs-toggle="dropdown"]')
+
    • +
  • +

    popperConfig can be passed as a function that accepts the Bootstrap’s default Popper config as an argument, so that you can merge this default configuration in your way. Applies to dropdowns, popovers, and tooltips.

    +
    • +
  • +

    The default value for the fallbackPlacements is changed to ['top', 'right', 'bottom', 'left'] for better placement of Popper elements. Applies to dropdowns, popovers, and tooltips.

    +
    • +
  • +

    Removed underscore from public static methods like _getInstance() → getInstance().

    +
    • +
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/api/index.html b/docs/5.3/utilities/api/index.html new file mode 100644 index 0000000000..4388567179 --- /dev/null +++ b/docs/5.3/utilities/api/index.html @@ -0,0 +1,1236 @@ + + + + + + + + + + + + +Utility API · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Utility API

+
+

The utility API is a Sass-based tool to generate utility classes.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Bootstrap utilities are generated with our utility API and can be used to modify or extend our default set of utility classes via Sass. Our utility API is based on a series of Sass maps and functions for generating families of classes with various options. If you’re unfamiliar with Sass maps, read up on the official Sass docs to get started.

+

The $utilities map contains all our utilities and is later merged with your custom $utilities map, if present. The utility map contains a keyed list of utility groups which accept the following options:

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionTypeDefault valueDescription
propertyRequired–Name of the property, this can be a string or an array of strings (e.g., horizontal paddings or margins).
valuesRequired–List of values, or a map if you don’t want the class name to be the same as the value. If null is used as map key, class is not prepended to the class name.
classOptionalnullName of the generated class. If not provided and property is an array of strings, class will default to the first element of the property array. If not provided and property is a string, the values keys are used for the class names.
css-varOptionalfalseBoolean to generate CSS variables instead of CSS rules.
css-variable-nameOptionalnullCustom un-prefixed name for the CSS variable inside the ruleset.
local-varsOptionalnullMap of local CSS variables to generate in addition to the CSS rules.
stateOptionalnullList of pseudo-class variants (e.g., :hover or :focus) to generate.
responsiveOptionalfalseBoolean indicating if responsive classes should be generated.
rfsOptionalfalseBoolean to enable fluid rescaling with RFS.
printOptionalfalseBoolean indicating if print classes need to be generated.
rtlOptionaltrueBoolean indicating if utility should be kept in RTL.
+ +

API explained

+

All utility variables are added to the $utilities variable within our _utilities.scss stylesheet. Each group of utilities looks something like this:

+
$utilities: (
+  "opacity": (
+    property: opacity,
+    values: (
+      0: 0,
+      25: .25,
+      50: .5,
+      75: .75,
+      100: 1,
+    )
+  )
+);
+

Which outputs the following:

+
.opacity-0 { opacity: 0; }
+.opacity-25 { opacity: .25; }
+.opacity-50 { opacity: .5; }
+.opacity-75 { opacity: .75; }
+.opacity-100 { opacity: 1; }
+

Property

+

The required property key must be set for any utility, and it must contain a valid CSS property. This property is used in the generated utility’s ruleset. When the class key is omitted, it also serves as the default class name. Consider the text-decoration utility:

+
$utilities: (
+  "text-decoration": (
+    property: text-decoration,
+    values: none underline line-through
+  )
+);
+

Output:

+
.text-decoration-none { text-decoration: none !important; }
+.text-decoration-underline { text-decoration: underline !important; }
+.text-decoration-line-through { text-decoration: line-through !important; }
+

Values

+

Use the values key to specify which values for the specified property should be used in the generated class names and rules. Can be a list or map (set in the utilities or in a Sass variable).

+

As a list, like with text-decoration utilities:

+
values: none underline line-through
+

As a map, like with opacity utilities:

+
values: (
+  0: 0,
+  25: .25,
+  50: .5,
+  75: .75,
+  100: 1,
+)
+

As a Sass variable that sets the list or map, as in our position utilities:

+
values: $position-values
+

Class

+

Use the class option to change the class prefix used in the compiled CSS. For example, to change from .opacity-* to .o-*:

+
$utilities: (
+  "opacity": (
+    property: opacity,
+    class: o,
+    values: (
+      0: 0,
+      25: .25,
+      50: .5,
+      75: .75,
+      100: 1,
+    )
+  )
+);
+

Output:

+
.o-0 { opacity: 0 !important; }
+.o-25 { opacity: .25 !important; }
+.o-50 { opacity: .5 !important; }
+.o-75 { opacity: .75 !important; }
+.o-100 { opacity: 1 !important; }
+

If class: null, generates classes for each of the values keys:

+
$utilities: (
+  "visibility": (
+    property: visibility,
+    class: null,
+    values: (
+      visible: visible,
+      invisible: hidden,
+    )
+  )
+);
+

Output:

+
.visible { visibility: visible !important; }
+.invisible { visibility: hidden !important; }
+

CSS variable utilities

+

Set the css-var boolean option to true and the API will generate local CSS variables for the given selector instead of the usual property: value rules. Add an optional css-variable-name to set a different CSS variable name than the class name.

+

Consider our .text-opacity-* utilities. If we add the css-variable-name option, we’ll get a custom output.

+
$utilities: (
+  "text-opacity": (
+    css-var: true,
+    css-variable-name: text-alpha,
+    class: text-opacity,
+    values: (
+      25: .25,
+      50: .5,
+      75: .75,
+      100: 1
+    )
+  ),
+);
+

Output:

+
.text-opacity-25 { --bs-text-alpha: .25; }
+.text-opacity-50 { --bs-text-alpha: .5; }
+.text-opacity-75 { --bs-text-alpha: .75; }
+.text-opacity-100 { --bs-text-alpha: 1; }
+

Local CSS variables

+

Use the local-vars option to specify a Sass map that will generate local CSS variables within the utility class’s ruleset. Please note that it may require additional work to consume those local CSS variables in the generated CSS rules. For example, consider our .bg-* utilities:

+
$utilities: (
+  "background-color": (
+    property: background-color,
+    class: bg,
+    local-vars: (
+      "bg-opacity": 1
+    ),
+    values: map-merge(
+      $utilities-bg-colors,
+      (
+        "transparent": transparent
+      )
+    )
+  )
+);
+

Output:

+
.bg-primary {
+  --bs-bg-opacity: 1;
+  background-color: rgba(var(--bs-primary-rgb), var(--bs-bg-opacity)) !important;
+}
+

States

+

Use the state option to generate pseudo-class variations. Example pseudo-classes are :hover and :focus. When a list of states are provided, classnames are created for that pseudo-class. For example, to change opacity on hover, add state: hover and you’ll get .opacity-hover:hover in your compiled CSS.

+

Need multiple pseudo-classes? Use a space-separated list of states: state: hover focus.

+
$utilities: (
+  "opacity": (
+    property: opacity,
+    class: opacity,
+    state: hover,
+    values: (
+      0: 0,
+      25: .25,
+      50: .5,
+      75: .75,
+      100: 1,
+    )
+  )
+);
+

Output:

+
.opacity-0-hover:hover { opacity: 0 !important; }
+.opacity-25-hover:hover { opacity: .25 !important; }
+.opacity-50-hover:hover { opacity: .5 !important; }
+.opacity-75-hover:hover { opacity: .75 !important; }
+.opacity-100-hover:hover { opacity: 1 !important; }
+

Responsive

+

Add the responsive boolean to generate responsive utilities (e.g., .opacity-md-25) across all breakpoints.

+
$utilities: (
+  "opacity": (
+    property: opacity,
+    responsive: true,
+    values: (
+      0: 0,
+      25: .25,
+      50: .5,
+      75: .75,
+      100: 1,
+    )
+  )
+);
+

Output:

+
.opacity-0 { opacity: 0 !important; }
+.opacity-25 { opacity: .25 !important; }
+.opacity-50 { opacity: .5 !important; }
+.opacity-75 { opacity: .75 !important; }
+.opacity-100 { opacity: 1 !important; }
+
+@media (min-width: 576px) {
+  .opacity-sm-0 { opacity: 0 !important; }
+  .opacity-sm-25 { opacity: .25 !important; }
+  .opacity-sm-50 { opacity: .5 !important; }
+  .opacity-sm-75 { opacity: .75 !important; }
+  .opacity-sm-100 { opacity: 1 !important; }
+}
+
+@media (min-width: 768px) {
+  .opacity-md-0 { opacity: 0 !important; }
+  .opacity-md-25 { opacity: .25 !important; }
+  .opacity-md-50 { opacity: .5 !important; }
+  .opacity-md-75 { opacity: .75 !important; }
+  .opacity-md-100 { opacity: 1 !important; }
+}
+
+@media (min-width: 992px) {
+  .opacity-lg-0 { opacity: 0 !important; }
+  .opacity-lg-25 { opacity: .25 !important; }
+  .opacity-lg-50 { opacity: .5 !important; }
+  .opacity-lg-75 { opacity: .75 !important; }
+  .opacity-lg-100 { opacity: 1 !important; }
+}
+
+@media (min-width: 1200px) {
+  .opacity-xl-0 { opacity: 0 !important; }
+  .opacity-xl-25 { opacity: .25 !important; }
+  .opacity-xl-50 { opacity: .5 !important; }
+  .opacity-xl-75 { opacity: .75 !important; }
+  .opacity-xl-100 { opacity: 1 !important; }
+}
+
+@media (min-width: 1400px) {
+  .opacity-xxl-0 { opacity: 0 !important; }
+  .opacity-xxl-25 { opacity: .25 !important; }
+  .opacity-xxl-50 { opacity: .5 !important; }
+  .opacity-xxl-75 { opacity: .75 !important; }
+  .opacity-xxl-100 { opacity: 1 !important; }
+}
+

Print

+

Enabling the print option will also generate utility classes for print, which are only applied within the @media print { ... } media query.

+
$utilities: (
+  "opacity": (
+    property: opacity,
+    print: true,
+    values: (
+      0: 0,
+      25: .25,
+      50: .5,
+      75: .75,
+      100: 1,
+    )
+  )
+);
+

Output:

+
.opacity-0 { opacity: 0 !important; }
+.opacity-25 { opacity: .25 !important; }
+.opacity-50 { opacity: .5 !important; }
+.opacity-75 { opacity: .75 !important; }
+.opacity-100 { opacity: 1 !important; }
+
+@media print {
+  .opacity-print-0 { opacity: 0 !important; }
+  .opacity-print-25 { opacity: .25 !important; }
+  .opacity-print-50 { opacity: .5 !important; }
+  .opacity-print-75 { opacity: .75 !important; }
+  .opacity-print-100 { opacity: 1 !important; }
+}
+

Importance

+

All utilities generated by the API include !important to ensure they override components and modifier classes as intended. You can toggle this setting globally with the $enable-important-utilities variable (defaults to true).

+

Using the API

+

Now that you’re familiar with how the utilities API works, learn how to add your own custom classes and modify our default utilities.

+

Override utilities

+

Override existing utilities by using the same key. For example, if you want additional responsive overflow utility classes, you can do this:

+
$utilities: (
+  "overflow": (
+    responsive: true,
+    property: overflow,
+    values: visible hidden scroll auto,
+  ),
+);
+

Add utilities

+

New utilities can be added to the default $utilities map with a map-merge. Make sure our required Sass files and _utilities.scss are imported first, then use the map-merge to add your additional utilities. For example, here’s how to add a responsive cursor utility with three values.

+
@import "bootstrap/scss/functions";
+@import "bootstrap/scss/variables";
+@import "bootstrap/scss/maps";
+@import "bootstrap/scss/mixins";
+@import "bootstrap/scss/utilities";
+
+$utilities: map-merge(
+  $utilities,
+  (
+    "cursor": (
+      property: cursor,
+      class: cursor,
+      responsive: true,
+      values: auto pointer grab,
+    )
+  )
+);
+
+@import "bootstrap/scss/utilities/api";
+

Modify utilities

+

Modify existing utilities in the default $utilities map with map-get and map-merge functions. In the example below, we’re adding an additional value to the width utilities. Start with an initial map-merge and then specify which utility you want to modify. From there, fetch the nested "width" map with map-get to access and modify the utility’s options and values.

+
@import "bootstrap/scss/functions";
+@import "bootstrap/scss/variables";
+@import "bootstrap/scss/maps";
+@import "bootstrap/scss/mixins";
+@import "bootstrap/scss/utilities";
+
+$utilities: map-merge(
+  $utilities,
+  (
+    "width": map-merge(
+      map-get($utilities, "width"),
+      (
+        values: map-merge(
+          map-get(map-get($utilities, "width"), "values"),
+          (10: 10%),
+        ),
+      ),
+    ),
+  )
+);
+
+@import "bootstrap/scss/utilities/api";
+

Enable responsive

+

You can enable responsive classes for an existing set of utilities that are not currently responsive by default. For example, to make the border classes responsive:

+
@import "bootstrap/scss/functions";
+@import "bootstrap/scss/variables";
+@import "bootstrap/scss/maps";
+@import "bootstrap/scss/mixins";
+@import "bootstrap/scss/utilities";
+
+$utilities: map-merge(
+  $utilities, (
+    "border": map-merge(
+      map-get($utilities, "border"),
+      ( responsive: true ),
+    ),
+  )
+);
+
+@import "bootstrap/scss/utilities/api";
+

This will now generate responsive variations of .border and .border-0 for each breakpoint. Your generated CSS will look like this:

+
.border { ... }
+.border-0 { ... }
+
+@media (min-width: 576px) {
+  .border-sm { ... }
+  .border-sm-0 { ... }
+}
+
+@media (min-width: 768px) {
+  .border-md { ... }
+  .border-md-0 { ... }
+}
+
+@media (min-width: 992px) {
+  .border-lg { ... }
+  .border-lg-0 { ... }
+}
+
+@media (min-width: 1200px) {
+  .border-xl { ... }
+  .border-xl-0 { ... }
+}
+
+@media (min-width: 1400px) {
+  .border-xxl { ... }
+  .border-xxl-0 { ... }
+}
+

Rename utilities

+

Missing v4 utilities, or used to another naming convention? The utilities API can be used to override the resulting class of a given utility—for example, to rename .ms-* utilities to oldish .ml-*:

+
@import "bootstrap/scss/functions";
+@import "bootstrap/scss/variables";
+@import "bootstrap/scss/maps";
+@import "bootstrap/scss/mixins";
+@import "bootstrap/scss/utilities";
+
+$utilities: map-merge(
+  $utilities, (
+    "margin-start": map-merge(
+      map-get($utilities, "margin-start"),
+      ( class: ml ),
+    ),
+  )
+);
+
+@import "bootstrap/scss/utilities/api";
+

Remove utilities

+

Remove any of the default utilities with the map-remove() Sass function.

+
@import "bootstrap/scss/functions";
+@import "bootstrap/scss/variables";
+@import "bootstrap/scss/maps";
+@import "bootstrap/scss/mixins";
+@import "bootstrap/scss/utilities";
+
+// Remove multiple utilities with a comma-separated list
+$utilities: map-remove($utilities, "width", "float");
+
+@import "bootstrap/scss/utilities/api";
+

You can also use the map-merge() Sass function and set the group key to null to remove the utility.

+
@import "bootstrap/scss/functions";
+@import "bootstrap/scss/variables";
+@import "bootstrap/scss/maps";
+@import "bootstrap/scss/mixins";
+@import "bootstrap/scss/utilities";
+
+$utilities: map-merge(
+  $utilities,
+  (
+    "width": null
+  )
+);
+
+@import "bootstrap/scss/utilities/api";
+

Add, remove, modify

+

You can add, remove, and modify many utilities all at once with the map-merge() Sass function. Here’s how you can combine the previous examples into one larger map.

+
@import "bootstrap/scss/functions";
+@import "bootstrap/scss/variables";
+@import "bootstrap/scss/maps";
+@import "bootstrap/scss/mixins";
+@import "bootstrap/scss/utilities";
+
+$utilities: map-merge(
+  $utilities,
+  (
+    // Remove the `width` utility
+    "width": null,
+
+    // Make an existing utility responsive
+    "border": map-merge(
+      map-get($utilities, "border"),
+      ( responsive: true ),
+    ),
+
+    // Add new utilities
+    "cursor": (
+      property: cursor,
+      class: cursor,
+      responsive: true,
+      values: auto pointer grab,
+    )
+  )
+);
+
+@import "bootstrap/scss/utilities/api";
+

Remove utility in RTL

+

Some edge cases make RTL styling difficult, such as line breaks in Arabic. Thus utilities can be dropped from RTL output by setting the rtl option to false:

+
$utilities: (
+  "word-wrap": (
+    property: word-wrap word-break,
+    class: text,
+    values: (break: break-word),
+    rtl: false
+  ),
+);
+

Output:

+
/* rtl:begin:remove */
+.text-break {
+  word-wrap: break-word !important;
+  word-break: break-word !important;
+}
+/* rtl:end:remove */
+

This doesn’t output anything in RTL, thanks to the RTLCSS remove control directive.

+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/background/index.html b/docs/5.3/utilities/background/index.html new file mode 100644 index 0000000000..fe338d59da --- /dev/null +++ b/docs/5.3/utilities/background/index.html @@ -0,0 +1,1001 @@ + + + + + + + + + + + + +Background · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Background

+
+

Convey meaning through background-color and add decoration with gradients.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Background color

+

Similar to the contextual text color classes, set the background of an element to any contextual class. Background utilities do not set color, so in some cases you’ll want to use .text-* color utilities.

+
+ +
.bg-primary
+
.bg-primary-subtle
+
.bg-secondary
+
.bg-secondary-subtle
+
.bg-success
+
.bg-success-subtle
+
.bg-danger
+
.bg-danger-subtle
+
.bg-warning
+
.bg-warning-subtle
+
.bg-info
+
.bg-info-subtle
+
.bg-light
+
.bg-light-subtle
+
.bg-dark
+
.bg-dark-subtle
+

.bg-body-secondary

+

.bg-body-tertiary

+ +
.bg-body
+
.bg-black
+
.bg-white
+
.bg-transparent
+
+ html +
+ + +
+ 
<div class="p-3 mb-2 bg-primary text-white">.bg-primary</div>
+<div class="p-3 mb-2 bg-primary-subtle text-emphasis-primary">.bg-primary-subtle</div>
+<div class="p-3 mb-2 bg-secondary text-white">.bg-secondary</div>
+<div class="p-3 mb-2 bg-secondary-subtle text-emphasis-secondary">.bg-secondary-subtle</div>
+<div class="p-3 mb-2 bg-success text-white">.bg-success</div>
+<div class="p-3 mb-2 bg-success-subtle text-emphasis-success">.bg-success-subtle</div>
+<div class="p-3 mb-2 bg-danger text-white">.bg-danger</div>
+<div class="p-3 mb-2 bg-danger-subtle text-emphasis-danger">.bg-danger-subtle</div>
+<div class="p-3 mb-2 bg-warning text-dark">.bg-warning</div>
+<div class="p-3 mb-2 bg-warning-subtle text-emphasis-warning">.bg-warning-subtle</div>
+<div class="p-3 mb-2 bg-info text-dark">.bg-info</div>
+<div class="p-3 mb-2 bg-info-subtle text-emphasis-info">.bg-info-subtle</div>
+<div class="p-3 mb-2 bg-light text-dark">.bg-light</div>
+<div class="p-3 mb-2 bg-light-subtle text-emphasis-light">.bg-light-subtle</div>
+<div class="p-3 mb-2 bg-dark text-white">.bg-dark</div>
+<div class="p-3 mb-2 bg-dark-subtle text-emphasis-dark">.bg-dark-subtle</div>
+<p class="p-3 mb-2 bg-body-secondary">.bg-body-secondary</p>
+<p class="p-3 mb-2 bg-body-tertiary">.bg-body-tertiary</p>
+
+<div class="p-3 mb-2 bg-body text-body">.bg-body</div>
+<div class="p-3 mb-2 bg-black text-white">.bg-black</div>
+<div class="p-3 mb-2 bg-white text-dark">.bg-white</div>
+<div class="p-3 mb-2 bg-transparent text-body">.bg-transparent</div>
+ +

Background gradient

+

By adding a .bg-gradient class, a linear gradient is added as background image to the backgrounds. This gradient starts with a semi-transparent white which fades out to the bottom.

+

Do you need a gradient in your custom CSS? Just add background-image: var(--bs-gradient);.

+
.bg-primary.bg-gradient
+
.bg-secondary.bg-gradient
+
.bg-success.bg-gradient
+
.bg-danger.bg-gradient
+
.bg-warning.bg-gradient
+
.bg-info.bg-gradient
+
.bg-light.bg-gradient
+
.bg-dark.bg-gradient
+
.bg-black.bg-gradient
+ +

Opacity

+Added in v5.1.0 + +

As of v5.1.0, background-color utilities are generated with Sass using CSS variables. This allows for real-time color changes without compilation and dynamic alpha transparency changes.

+

How it works

+

Consider our default .bg-success utility.

+
.bg-success {
+  --bs-bg-opacity: 1;
+  background-color: rgba(var(--bs-success-rgb), var(--bs-bg-opacity)) !important;
+}
+

We use an RGB version of our --bs-success (with the value of 25, 135, 84) CSS variable and attached a second CSS variable, --bs-bg-opacity, for the alpha transparency (with a default value 1 thanks to a local CSS variable). That means anytime you use .bg-success now, your computed color value is rgba(25, 135, 84, 1). The local CSS variable inside each .bg-* class avoids inheritance issues so nested instances of the utilities don’t automatically have a modified alpha transparency.

+

Example

+

To change that opacity, override --bs-bg-opacity via custom styles or inline styles.

+
+
This is default success background
+
This is 50% opacity success background
+
+ html +
+ + +
+ 
<div class="bg-success p-2 text-white">This is default success background</div>
+<div class="bg-success p-2" style="--bs-bg-opacity: .5;">This is 50% opacity success background</div>
+ +

Or, choose from any of the .bg-opacity utilities:

+
+
This is default success background
+
This is 75% opacity success background
+
This is 50% opacity success background
+
This is 25% opacity success background
+
This is 10% opacity success background
+
+ html +
+ + +
+ 
<div class="bg-success p-2 text-white">This is default success background</div>
+<div class="bg-success p-2 text-white bg-opacity-75">This is 75% opacity success background</div>
+<div class="bg-success p-2 text-dark bg-opacity-50">This is 50% opacity success background</div>
+<div class="bg-success p-2 text-dark bg-opacity-25">This is 25% opacity success background</div>
+<div class="bg-success p-2 text-dark bg-opacity-10">This is 10% opacity success background</div>
+ +

Sass

+

In addition to the following Sass functionality, consider reading about our included CSS custom properties (aka CSS variables) for colors and more.

+

Variables

+

Most background-color utilities are generated by our theme colors, reassigned from our generic color palette variables.

+
$blue:    #0d6efd;
+$indigo:  #6610f2;
+$purple:  #6f42c1;
+$pink:    #d63384;
+$red:     #dc3545;
+$orange:  #fd7e14;
+$yellow:  #ffc107;
+$green:   #198754;
+$teal:    #20c997;
+$cyan:    #0dcaf0;
+
+
$primary:       $blue;
+$secondary:     $gray-600;
+$success:       $green;
+$info:          $cyan;
+$warning:       $yellow;
+$danger:        $red;
+$light:         $gray-100;
+$dark:          $gray-900;
+
+
$gradient: linear-gradient(180deg, rgba($white, .15), rgba($white, 0));
+
+

Grayscale colors are also available, but only a subset are used to generate any utilities.

+
$white:    #fff;
+$gray-100: #f8f9fa;
+$gray-200: #e9ecef;
+$gray-300: #dee2e6;
+$gray-400: #ced4da;
+$gray-500: #adb5bd;
+$gray-600: #6c757d;
+$gray-700: #495057;
+$gray-800: #343a40;
+$gray-900: #212529;
+$black:    #000;
+
+

Map

+

Theme colors are then put into a Sass map so we can loop over them to generate our utilities, component modifiers, and more.

+
$theme-colors: (
+  "primary":    $primary,
+  "secondary":  $secondary,
+  "success":    $success,
+  "info":       $info,
+  "warning":    $warning,
+  "danger":     $danger,
+  "light":      $light,
+  "dark":       $dark
+);
+
+

Grayscale colors are also available as a Sass map. This map is not used to generate any utilities.

+
$grays: (
+  "100": $gray-100,
+  "200": $gray-200,
+  "300": $gray-300,
+  "400": $gray-400,
+  "500": $gray-500,
+  "600": $gray-600,
+  "700": $gray-700,
+  "800": $gray-800,
+  "900": $gray-900
+);
+
+

RGB colors are generated from a separate Sass map:

+
$theme-colors-rgb: map-loop($theme-colors, to-rgb, "$value");
+
+

And background color opacities build on that with their own map that’s consumed by the utilities API:

+
$utilities-bg: map-merge(
+  $utilities-colors,
+  (
+    "black": to-rgb($black),
+    "white": to-rgb($white),
+    "body": to-rgb($body-bg)
+  )
+);
+$utilities-bg-colors: map-loop($utilities-bg, rgba-css-var, "$key", "bg");
+
+$utilities-bg-subtle: (
+  "primary-subtle": var(--#{$prefix}primary-bg-subtle),
+  "secondary-subtle": var(--#{$prefix}secondary-bg-subtle),
+  "success-subtle": var(--#{$prefix}success-bg-subtle),
+  "info-subtle": var(--#{$prefix}info-bg-subtle),
+  "warning-subtle": var(--#{$prefix}warning-bg-subtle),
+  "danger-subtle": var(--#{$prefix}danger-bg-subtle),
+  "light-subtle": var(--#{$prefix}light-bg-subtle),
+  "dark-subtle": var(--#{$prefix}dark-bg-subtle)
+);
+// $utilities-bg-subtle-colors: map-loop($utilities-bg-subtle, rgba-css-var, "$key", "bg");
+
+

Mixins

+

No mixins are used to generate our background utilities, but we do have some additional mixins for other situations where you’d like to create your own gradients.

+
@mixin gradient-bg($color: null) {
+  background-color: $color;
+
+  @if $enable-gradients {
+    background-image: var(--#{$prefix}gradient);
+  }
+}
+
+
// Horizontal gradient, from left to right
+//
+// Creates two color stops, start and end, by specifying a color and position for each color stop.
+@mixin gradient-x($start-color: $gray-700, $end-color: $gray-800, $start-percent: 0%, $end-percent: 100%) {
+  background-image: linear-gradient(to right, $start-color $start-percent, $end-color $end-percent);
+}
+
+// Vertical gradient, from top to bottom
+//
+// Creates two color stops, start and end, by specifying a color and position for each color stop.
+@mixin gradient-y($start-color: $gray-700, $end-color: $gray-800, $start-percent: null, $end-percent: null) {
+  background-image: linear-gradient(to bottom, $start-color $start-percent, $end-color $end-percent);
+}
+
+@mixin gradient-directional($start-color: $gray-700, $end-color: $gray-800, $deg: 45deg) {
+  background-image: linear-gradient($deg, $start-color, $end-color);
+}
+
+@mixin gradient-x-three-colors($start-color: $blue, $mid-color: $purple, $color-stop: 50%, $end-color: $red) {
+  background-image: linear-gradient(to right, $start-color, $mid-color $color-stop, $end-color);
+}
+
+@mixin gradient-y-three-colors($start-color: $blue, $mid-color: $purple, $color-stop: 50%, $end-color: $red) {
+  background-image: linear-gradient($start-color, $mid-color $color-stop, $end-color);
+}
+
+@mixin gradient-radial($inner-color: $gray-700, $outer-color: $gray-800) {
+  background-image: radial-gradient(circle, $inner-color, $outer-color);
+}
+
+@mixin gradient-striped($color: rgba($white, .15), $angle: 45deg) {
+  background-image: linear-gradient($angle, $color 25%, transparent 25%, transparent 50%, $color 50%, $color 75%, transparent 75%, transparent);
+}
+
+

Utilities API

+

Background utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "background-color": (
+      property: background-color,
+      class: bg,
+      local-vars: (
+        "bg-opacity": 1
+      ),
+      values: map-merge(
+        $utilities-bg-colors,
+        (
+          "transparent": transparent,
+          "body-secondary": rgba(var(--#{$prefix}secondary-bg-rgb), var(--#{$prefix}bg-opacity)),
+          "body-tertiary": rgba(var(--#{$prefix}tertiary-bg-rgb), var(--#{$prefix}bg-opacity)),
+          "body-emphasis": rgba(var(--#{$prefix}emphasis-bg-rgb), var(--#{$prefix}bg-opacity)),
+        )
+      )
+    ),
+    "bg-opacity": (
+      css-var: true,
+      class: bg-opacity,
+      values: (
+        10: .1,
+        25: .25,
+        50: .5,
+        75: .75,
+        100: 1
+      )
+    ),
+    "subtle-background-color": (
+      property: background-color,
+      class: bg,
+      values: $utilities-bg-subtle
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/borders/index.html b/docs/5.3/utilities/borders/index.html new file mode 100644 index 0000000000..e749e7ca2e --- /dev/null +++ b/docs/5.3/utilities/borders/index.html @@ -0,0 +1,1247 @@ + + + + + + + + + + + + +Borders · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Borders

+
+

Use border utilities to quickly style the border and border-radius of an element. Great for images, buttons, or any other element.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Border

+

Use border utilities to add or remove an element’s borders. Choose from all borders or one at a time.

+

Additive

+

Add borders to custom elements:

+
+ + + + + +
+ html +
+ + +
+ 
<span class="border"></span>
+<span class="border-top"></span>
+<span class="border-end"></span>
+<span class="border-bottom"></span>
+<span class="border-start"></span>
+ +

Subtractive

+

Or remove borders:

+
+ + + + + +
+ html +
+ + +
+ 
<span class="border border-0"></span>
+<span class="border border-top-0"></span>
+<span class="border border-end-0"></span>
+<span class="border border-bottom-0"></span>
+<span class="border border-start-0"></span>
+ +

Color

+

Change the border color using utilities built on our theme colors.

+
+ + + + + + + + + + + + + + + + + + +
+ html +
+ + +
+ 
<span class="border border-primary"></span>
+<span class="border border-primary-subtle"></span>
+<span class="border border-secondary"></span>
+<span class="border border-secondary-subtle"></span>
+<span class="border border-success"></span>
+<span class="border border-success-subtle"></span>
+<span class="border border-danger"></span>
+<span class="border border-danger-subtle"></span>
+<span class="border border-warning"></span>
+<span class="border border-warning-subtle"></span>
+<span class="border border-info"></span>
+<span class="border border-info-subtle"></span>
+<span class="border border-light"></span>
+<span class="border border-light-subtle"></span>
+<span class="border border-dark"></span>
+<span class="border border-dark-subtle"></span>
+<span class="border border-white"></span>
+ +

Or modify the default border-color of a component:

+
+
+ + +
+ +
+ Dangerous heading +
+ +
+ Changing border color and width +
+
+ html +
+ + +
+ 
<div class="mb-4">
+  <label for="exampleFormControlInput1" class="form-label">Email address</label>
+  <input type="email" class="form-control border-success" id="exampleFormControlInput1" placeholder="name@example.com">
+</div>
+
+<div class="h4 pb-2 mb-4 text-danger border-bottom border-danger">
+  Dangerous heading
+</div>
+
+<div class="p-3 bg-info bg-opacity-10 border border-info border-start-0 rounded-end">
+  Changing border color and width
+</div>
+ +

Opacity

+Added in v5.2.0 + +

Bootstrap border-{color} utilities are generated with Sass using CSS variables. This allows for real-time color changes without compilation and dynamic alpha transparency changes.

+

How it works

+

Consider our default .border-success utility.

+
.border-success {
+  --bs-border-opacity: 1;
+  border-color: rgba(var(--bs-success-rgb), var(--bs-border-opacity)) !important;
+}
+

We use an RGB version of our --bs-success (with the value of 25, 135, 84) CSS variable and attached a second CSS variable, --bs-border-opacity, for the alpha transparency (with a default value 1 thanks to a local CSS variable). That means anytime you use .border-success now, your computed color value is rgba(25, 135, 84, 1). The local CSS variable inside each .border-* class avoids inheritance issues so nested instances of the utilities don’t automatically have a modified alpha transparency.

+

Example

+

To change that opacity, override --bs-border-opacity via custom styles or inline styles.

+
+
This is default success border
+
This is 50% opacity success border
+
+ html +
+ + +
+ 
<div class="border border-success p-2 mb-2">This is default success border</div>
+<div class="border border-success p-2" style="--bs-border-opacity: .5;">This is 50% opacity success border</div>
+ +

Or, choose from any of the .border-opacity utilities:

+
+
This is default success border
+
This is 75% opacity success border
+
This is 50% opacity success border
+
This is 25% opacity success border
+
This is 10% opacity success border
+
+ html +
+ + +
+ 
<div class="border border-success p-2 mb-2">This is default success border</div>
+<div class="border border-success p-2 mb-2 border-opacity-75">This is 75% opacity success border</div>
+<div class="border border-success p-2 mb-2 border-opacity-50">This is 50% opacity success border</div>
+<div class="border border-success p-2 mb-2 border-opacity-25">This is 25% opacity success border</div>
+<div class="border border-success p-2 border-opacity-10">This is 10% opacity success border</div>
+ +

Width

+
+ + + + + +
+ html +
+ + +
+ 
<span class="border border-1"></span>
+<span class="border border-2"></span>
+<span class="border border-3"></span>
+<span class="border border-4"></span>
+<span class="border border-5"></span>
+ +

Radius

+

Add classes to an element to easily round its corners.

+
+Example rounded image75x75 +Example top rounded image75x75 +Example right rounded image75x75 +Example bottom rounded image75x75 +Example left rounded image75x75 +Completely round image75x75 +Rounded pill image150x75 +
+ html +
+ + +
+ 
<img src="..." class="rounded" alt="...">
+<img src="..." class="rounded-top" alt="...">
+<img src="..." class="rounded-end" alt="...">
+<img src="..." class="rounded-bottom" alt="...">
+<img src="..." class="rounded-start" alt="...">
+<img src="..." class="rounded-circle" alt="...">
+<img src="..." class="rounded-pill" alt="...">
+ +

Sizes

+

Use the scaling classes for larger or smaller rounded corners. Sizes range from 0 to 5, and can be configured by modifying the utilities API.

+
+Example non-rounded image75x75 +Example small rounded image75x75 +Example default rounded image75x75 +Example large rounded image75x75 +Example larger rounded image75x75 +Example extra large rounded image75x75 +
+ html +
+ + +
+ 
<img src="..." class="rounded-0" alt="...">
+<img src="..." class="rounded-1" alt="...">
+<img src="..." class="rounded-2" alt="...">
+<img src="..." class="rounded-3" alt="...">
+<img src="..." class="rounded-4" alt="...">
+<img src="..." class="rounded-5" alt="...">
+ +
+Example small rounded image75x75 +Example default left rounded image75x75 +Example right completely round image75x75 +Example left rounded pill image75x75 +Example extra large bottom rounded image75x75 +
+ html +
+ + +
+ 
<img src="..." class="rounded-bottom-1" alt="...">
+<img src="..." class="rounded-start-2" alt="...">
+<img src="..." class="rounded-end-circle" alt="...">
+<img src="..." class="rounded-start-pill" alt="...">
+<img src="..." class="rounded-5 rounded-top-0" alt="...">
+ +

CSS

+

Variables

+Added in v5.2.0 + +
  --#{$prefix}border-width: #{$border-width};
+  --#{$prefix}border-style: #{$border-style};
+  --#{$prefix}border-color: #{$border-color};
+  --#{$prefix}border-color-translucent: #{$border-color-translucent};
+
+  --#{$prefix}border-radius: #{$border-radius};
+  --#{$prefix}border-radius-sm: #{$border-radius-sm};
+  --#{$prefix}border-radius-lg: #{$border-radius-lg};
+  --#{$prefix}border-radius-xl: #{$border-radius-xl};
+  --#{$prefix}border-radius-2xl: #{$border-radius-2xl};
+  --#{$prefix}border-radius-pill: #{$border-radius-pill};
+
+

Sass variables

+
$border-width:                1px;
+$border-widths: (
+  1: 1px,
+  2: 2px,
+  3: 3px,
+  4: 4px,
+  5: 5px
+);
+$border-style:                solid;
+$border-color:                $gray-300;
+$border-color-translucent:    rgba($black, .175);
+
+
$border-radius:               .375rem;
+$border-radius-sm:            .25rem;
+$border-radius-lg:            .5rem;
+$border-radius-xl:            1rem;
+$border-radius-2xl:           2rem;
+$border-radius-pill:          50rem;
+
+

Sass mixins

+
@mixin border-radius($radius: $border-radius, $fallback-border-radius: false) {
+  @if $enable-rounded {
+    border-radius: valid-radius($radius);
+  }
+  @else if $fallback-border-radius != false {
+    border-radius: $fallback-border-radius;
+  }
+}
+
+@mixin border-top-radius($radius: $border-radius) {
+  @if $enable-rounded {
+    border-top-left-radius: valid-radius($radius);
+    border-top-right-radius: valid-radius($radius);
+  }
+}
+
+@mixin border-end-radius($radius: $border-radius) {
+  @if $enable-rounded {
+    border-top-right-radius: valid-radius($radius);
+    border-bottom-right-radius: valid-radius($radius);
+  }
+}
+
+@mixin border-bottom-radius($radius: $border-radius) {
+  @if $enable-rounded {
+    border-bottom-right-radius: valid-radius($radius);
+    border-bottom-left-radius: valid-radius($radius);
+  }
+}
+
+@mixin border-start-radius($radius: $border-radius) {
+  @if $enable-rounded {
+    border-top-left-radius: valid-radius($radius);
+    border-bottom-left-radius: valid-radius($radius);
+  }
+}
+
+@mixin border-top-start-radius($radius: $border-radius) {
+  @if $enable-rounded {
+    border-top-left-radius: valid-radius($radius);
+  }
+}
+
+@mixin border-top-end-radius($radius: $border-radius) {
+  @if $enable-rounded {
+    border-top-right-radius: valid-radius($radius);
+  }
+}
+
+@mixin border-bottom-end-radius($radius: $border-radius) {
+  @if $enable-rounded {
+    border-bottom-right-radius: valid-radius($radius);
+  }
+}
+
+@mixin border-bottom-start-radius($radius: $border-radius) {
+  @if $enable-rounded {
+    border-bottom-left-radius: valid-radius($radius);
+  }
+}
+
+

Utilities API

+

Border utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "border": (
+      property: border,
+      values: (
+        null: var(--#{$prefix}border-width) var(--#{$prefix}border-style) var(--#{$prefix}border-color),
+        0: 0,
+      )
+    ),
+    "border-top": (
+      property: border-top,
+      values: (
+        null: var(--#{$prefix}border-width) var(--#{$prefix}border-style) var(--#{$prefix}border-color),
+        0: 0,
+      )
+    ),
+    "border-end": (
+      property: border-right,
+      class: border-end,
+      values: (
+        null: var(--#{$prefix}border-width) var(--#{$prefix}border-style) var(--#{$prefix}border-color),
+        0: 0,
+      )
+    ),
+    "border-bottom": (
+      property: border-bottom,
+      values: (
+        null: var(--#{$prefix}border-width) var(--#{$prefix}border-style) var(--#{$prefix}border-color),
+        0: 0,
+      )
+    ),
+    "border-start": (
+      property: border-left,
+      class: border-start,
+      values: (
+        null: var(--#{$prefix}border-width) var(--#{$prefix}border-style) var(--#{$prefix}border-color),
+        0: 0,
+      )
+    ),
+    "border-color": (
+      property: border-color,
+      class: border,
+      local-vars: (
+        "border-opacity": 1
+      ),
+      values: $utilities-border-colors
+    ),
+    "subtle-border-color": (
+      property: border-color,
+      class: border,
+      values: $utilities-border-subtle
+    ),
+    "border-width": (
+      css-var: true,
+      css-variable-name: border-width,
+      class: border,
+      values: $border-widths
+    ),
+    "border-opacity": (
+      css-var: true,
+      class: border-opacity,
+      values: (
+        10: .1,
+        25: .25,
+        50: .5,
+        75: .75,
+        100: 1
+      )
+    ),
+
+
    "rounded": (
+      property: border-radius,
+      class: rounded,
+      values: (
+        null: var(--#{$prefix}border-radius),
+        0: 0,
+        1: var(--#{$prefix}border-radius-sm),
+        2: var(--#{$prefix}border-radius),
+        3: var(--#{$prefix}border-radius-lg),
+        4: var(--#{$prefix}border-radius-xl),
+        5: var(--#{$prefix}border-radius-2xl),
+        circle: 50%,
+        pill: var(--#{$prefix}border-radius-pill)
+      )
+    ),
+    "rounded-top": (
+      property: border-top-left-radius border-top-right-radius,
+      class: rounded-top,
+      values: (
+        null: var(--#{$prefix}border-radius),
+        0: 0,
+        1: var(--#{$prefix}border-radius-sm),
+        2: var(--#{$prefix}border-radius),
+        3: var(--#{$prefix}border-radius-lg),
+        4: var(--#{$prefix}border-radius-xl),
+        5: var(--#{$prefix}border-radius-2xl),
+        circle: 50%,
+        pill: var(--#{$prefix}border-radius-pill)
+      )
+    ),
+    "rounded-end": (
+      property: border-top-right-radius border-bottom-right-radius,
+      class: rounded-end,
+      values: (
+        null: var(--#{$prefix}border-radius),
+        0: 0,
+        1: var(--#{$prefix}border-radius-sm),
+        2: var(--#{$prefix}border-radius),
+        3: var(--#{$prefix}border-radius-lg),
+        4: var(--#{$prefix}border-radius-xl),
+        5: var(--#{$prefix}border-radius-2xl),
+        circle: 50%,
+        pill: var(--#{$prefix}border-radius-pill)
+      )
+    ),
+    "rounded-bottom": (
+      property: border-bottom-right-radius border-bottom-left-radius,
+      class: rounded-bottom,
+      values: (
+        null: var(--#{$prefix}border-radius),
+        0: 0,
+        1: var(--#{$prefix}border-radius-sm),
+        2: var(--#{$prefix}border-radius),
+        3: var(--#{$prefix}border-radius-lg),
+        4: var(--#{$prefix}border-radius-xl),
+        5: var(--#{$prefix}border-radius-2xl),
+        circle: 50%,
+        pill: var(--#{$prefix}border-radius-pill)
+      )
+    ),
+    "rounded-start": (
+      property: border-bottom-left-radius border-top-left-radius,
+      class: rounded-start,
+      values: (
+        null: var(--#{$prefix}border-radius),
+        0: 0,
+        1: var(--#{$prefix}border-radius-sm),
+        2: var(--#{$prefix}border-radius),
+        3: var(--#{$prefix}border-radius-lg),
+        4: var(--#{$prefix}border-radius-xl),
+        5: var(--#{$prefix}border-radius-2xl),
+        circle: 50%,
+        pill: var(--#{$prefix}border-radius-pill)
+      )
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/colors/index.html b/docs/5.3/utilities/colors/index.html new file mode 100644 index 0000000000..35dede88c5 --- /dev/null +++ b/docs/5.3/utilities/colors/index.html @@ -0,0 +1,963 @@ + + + + + + + + + + + + +Colors · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Colors

+
+

Convey meaning through color with a handful of color utility classes. Includes support for styling links with hover states, too.

+ + +
+ + +
+ + On this page +
+
+ +
+
+ + +
+ + +

Colors

+

Colorize text with color utilities. If you want to colorize links, you can use the .link-* helper classes which have :hover and :focus states.

+
+ +

.text-primary

+

.text-primary-emphasis

+

.text-secondary

+

.text-secondary-emphasis

+

.text-success

+

.text-success-emphasis

+

.text-danger

+

.text-danger-emphasis

+

.text-warning

+

.text-warning-emphasis

+

.text-info

+

.text-info-emphasis

+

.text-light

+

.text-light-emphasis

+

.text-dark

+

.text-dark-emphasis

+

.text-body

+

.text-muted

+ +

.text-body-emphasis

+

.text-body-secondary

+

.text-body-tertiary

+ +

.text-black

+

.text-white

+

.text-black-50

+

.text-white-50

+
+ html +
+ + +
+ 
<p class="text-primary">.text-primary</p>
+<p class="text-primary-emphasis">.text-primary-emphasis</p>
+<p class="text-secondary">.text-secondary</p>
+<p class="text-secondary-emphasis">.text-secondary-emphasis</p>
+<p class="text-success">.text-success</p>
+<p class="text-success-emphasis">.text-success-emphasis</p>
+<p class="text-danger">.text-danger</p>
+<p class="text-danger-emphasis">.text-danger-emphasis</p>
+<p class="text-warning bg-dark">.text-warning</p>
+<p class="text-warning-emphasis">.text-warning-emphasis</p>
+<p class="text-info bg-dark">.text-info</p>
+<p class="text-info-emphasis">.text-info-emphasis</p>
+<p class="text-light bg-dark">.text-light</p>
+<p class="text-light-emphasis">.text-light-emphasis</p>
+<p class="text-dark bg-white">.text-dark</p>
+<p class="text-dark-emphasis">.text-dark-emphasis</p>
+<p class="text-body">.text-body</p>
+<p class="text-muted">.text-muted</p>
+
+<p class="text-body-emphasis">.text-body-emphasis</p>
+<p class="text-body-secondary">.text-body-secondary</p>
+<p class="text-body-tertiary">.text-body-tertiary</p>
+
+<p class="text-black bg-white">.text-black</p>
+<p class="text-white bg-dark">.text-white</p>
+<p class="text-black-50 bg-white">.text-black-50</p>
+<p class="text-white-50 bg-dark">.text-white-50</p>
+ +
+Deprecation: With the addition of .text-opacity-* utilities and CSS variables for text utilities, .text-black-50 and .text-white-50 are deprecated as of v5.1.0. They’ll be removed in v6.0.0. +
+ +
+Deprecation: With the addition of the expanded theme colors and variables, the .text-muted utility has been deprecated as of v5.3.0. Its default value has also has been reassigned to the new --bs-secondary-color CSS variable to better support color modes. It will be removed in v6.0.0. +
+ +
+
Conveying meaning to assistive technologies
+

Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the .visually-hidden class. +

+ +

Opacity

+Added in v5.1.0 + +

As of v5.1.0, text color utilities are generated with Sass using CSS variables. This allows for real-time color changes without compilation and dynamic alpha transparency changes.

+

How it works

+

Consider our default .text-primary utility.

+
.text-primary {
+  --bs-text-opacity: 1;
+  color: rgba(var(--bs-primary-rgb), var(--bs-text-opacity)) !important;
+}
+

We use an RGB version of our --bs-primary (with the value of 13, 110, 253) CSS variable and attached a second CSS variable, --bs-text-opacity, for the alpha transparency (with a default value 1 thanks to a local CSS variable). That means anytime you use .text-primary now, your computed color value is rgba(13, 110, 253, 1). The local CSS variable inside each .text-* class avoids inheritance issues so nested instances of the utilities don’t automatically have a modified alpha transparency.

+

Example

+

To change that opacity, override --bs-text-opacity via custom styles or inline styles.

+
+
This is default primary text
+
This is 50% opacity primary text
+
+ html +
+ + +
+ 
<div class="text-primary">This is default primary text</div>
+<div class="text-primary" style="--bs-text-opacity: .5;">This is 50% opacity primary text</div>
+ +

Or, choose from any of the .text-opacity utilities:

+
+
This is default primary text
+
This is 75% opacity primary text
+
This is 50% opacity primary text
+
This is 25% opacity primary text
+
+ html +
+ + +
+ 
<div class="text-primary">This is default primary text</div>
+<div class="text-primary text-opacity-75">This is 75% opacity primary text</div>
+<div class="text-primary text-opacity-50">This is 50% opacity primary text</div>
+<div class="text-primary text-opacity-25">This is 25% opacity primary text</div>
+ +

Specificity

+

Sometimes contextual classes cannot be applied due to the specificity of another selector. In some cases, a sufficient workaround is to wrap your element’s content in a <div> or more semantic element with the desired class.

+

Sass

+

In addition to the following Sass functionality, consider reading about our included CSS custom properties (aka CSS variables) for colors and more.

+

Variables

+

Most color utilities are generated by our theme colors, reassigned from our generic color palette variables.

+
$blue:    #0d6efd;
+$indigo:  #6610f2;
+$purple:  #6f42c1;
+$pink:    #d63384;
+$red:     #dc3545;
+$orange:  #fd7e14;
+$yellow:  #ffc107;
+$green:   #198754;
+$teal:    #20c997;
+$cyan:    #0dcaf0;
+
+
$primary:       $blue;
+$secondary:     $gray-600;
+$success:       $green;
+$info:          $cyan;
+$warning:       $yellow;
+$danger:        $red;
+$light:         $gray-100;
+$dark:          $gray-900;
+
+

Grayscale colors are also available, but only a subset are used to generate any utilities.

+
$white:    #fff;
+$gray-100: #f8f9fa;
+$gray-200: #e9ecef;
+$gray-300: #dee2e6;
+$gray-400: #ced4da;
+$gray-500: #adb5bd;
+$gray-600: #6c757d;
+$gray-700: #495057;
+$gray-800: #343a40;
+$gray-900: #212529;
+$black:    #000;
+
+

Map

+

Theme colors are then put into a Sass map so we can loop over them to generate our utilities, component modifiers, and more.

+
$theme-colors: (
+  "primary":    $primary,
+  "secondary":  $secondary,
+  "success":    $success,
+  "info":       $info,
+  "warning":    $warning,
+  "danger":     $danger,
+  "light":      $light,
+  "dark":       $dark
+);
+
+

Grayscale colors are also available as a Sass map. This map is not used to generate any utilities.

+
$grays: (
+  "100": $gray-100,
+  "200": $gray-200,
+  "300": $gray-300,
+  "400": $gray-400,
+  "500": $gray-500,
+  "600": $gray-600,
+  "700": $gray-700,
+  "800": $gray-800,
+  "900": $gray-900
+);
+
+

RGB colors are generated from a separate Sass map:

+
$theme-colors-rgb: map-loop($theme-colors, to-rgb, "$value");
+
+

And color opacities build on that with their own map that’s consumed by the utilities API:

+
$utilities-text: map-merge(
+  $utilities-colors,
+  (
+    "black": to-rgb($black),
+    "white": to-rgb($white),
+    "body": to-rgb($body-color)
+  )
+);
+$utilities-text-colors: map-loop($utilities-text, rgba-css-var, "$key", "text");
+
+$utilities-text-emphasis-colors: (
+  "primary-emphasis": var(--#{$prefix}primary-text),
+  "secondary-emphasis": var(--#{$prefix}secondary-text),
+  "success-emphasis": var(--#{$prefix}success-text),
+  "info-emphasis": var(--#{$prefix}info-text),
+  "warning-emphasis": var(--#{$prefix}warning-text),
+  "danger-emphasis": var(--#{$prefix}danger-text),
+  "light-emphasis": var(--#{$prefix}light-text),
+  "dark-emphasis": var(--#{$prefix}dark-text)
+);
+
+

Utilities API

+

Color utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "color": (
+      property: color,
+      class: text,
+      local-vars: (
+        "text-opacity": 1
+      ),
+      values: map-merge(
+        $utilities-text-colors,
+        (
+          "muted": $text-muted, // deprecated
+          "black-50": rgba($black, .5), // deprecated
+          "white-50": rgba($white, .5), // deprecated
+          "body-secondary": var(--#{$prefix}secondary-color),
+          "body-tertiary": var(--#{$prefix}tertiary-color),
+          "body-emphasis": var(--#{$prefix}emphasis-color),
+          "reset": inherit,
+        )
+      )
+    ),
+    "text-opacity": (
+      css-var: true,
+      class: text-opacity,
+      values: (
+        25: .25,
+        50: .5,
+        75: .75,
+        100: 1
+      )
+    ),
+    "text-color": (
+      property: color,
+      class: text,
+      values: $utilities-text-emphasis-colors
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/display/index.html b/docs/5.3/utilities/display/index.html new file mode 100644 index 0000000000..821f46e894 --- /dev/null +++ b/docs/5.3/utilities/display/index.html @@ -0,0 +1,887 @@ + + + + + + + + + + + + +Display property · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Display property

+
+

Quickly and responsively toggle the display value of components and more with our display utilities. Includes support for some of the more common values, as well as some extras for controlling display when printing.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

How it works

+

Change the value of the display property with our responsive display utility classes. We purposely support only a subset of all possible values for display. Classes can be combined for various effects as you need.

+

Notation

+

Display utility classes that apply to all breakpoints, from xs to xxl, have no breakpoint abbreviation in them. This is because those classes are applied from min-width: 0; and up, and thus are not bound by a media query. The remaining breakpoints, however, do include a breakpoint abbreviation.

+

As such, the classes are named using the format:

+
    +
  • .d-{value} for xs
    • +
  • .d-{breakpoint}-{value} for sm, md, lg, xl, and xxl.
    • +
+

Where value is one of:

+
    +
  • none
    • +
  • inline
    • +
  • inline-block
    • +
  • block
    • +
  • grid
    • +
  • table
    • +
  • table-cell
    • +
  • table-row
    • +
  • flex
    • +
  • inline-flex
    • +
+

The display values can be altered by changing the display values defined in $utilities and recompiling the SCSS.

+

The media queries affect screen widths with the given breakpoint or larger. For example, .d-lg-none sets display: none; on lg, xl, and xxl screens.

+

Examples

+
+
d-inline
+
d-inline
+
+ html +
+ + +
+ 
<div class="d-inline p-2 text-bg-primary">d-inline</div>
+<div class="d-inline p-2 text-bg-dark">d-inline</div>
+ +
+d-block +d-block +
+ html +
+ + +
+ 
<span class="d-block p-2 text-bg-primary">d-block</span>
+<span class="d-block p-2 text-bg-dark">d-block</span>
+ +

Hiding elements

+

For faster mobile-friendly development, use responsive display classes for showing and hiding elements by device. Avoid creating entirely different versions of the same site, instead hide elements responsively for each screen size.

+

To hide elements simply use the .d-none class or one of the .d-{sm,md,lg,xl,xxl}-none classes for any responsive screen variation.

+

To show an element only on a given interval of screen sizes you can combine one .d-*-none class with a .d-*-* class, for example .d-none .d-md-block .d-xl-none .d-xxl-none will hide the element for all screen sizes except on medium and large devices.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Screen sizeClass
Hidden on all.d-none
Hidden only on xs.d-none .d-sm-block
Hidden only on sm.d-sm-none .d-md-block
Hidden only on md.d-md-none .d-lg-block
Hidden only on lg.d-lg-none .d-xl-block
Hidden only on xl.d-xl-none .d-xxl-block
Hidden only on xxl.d-xxl-none
Visible on all.d-block
Visible only on xs.d-block .d-sm-none
Visible only on sm.d-none .d-sm-block .d-md-none
Visible only on md.d-none .d-md-block .d-lg-none
Visible only on lg.d-none .d-lg-block .d-xl-none
Visible only on xl.d-none .d-xl-block .d-xxl-none
Visible only on xxl.d-none .d-xxl-block
+ +
+
hide on lg and wider screens
+
hide on screens smaller than lg
+
+ html +
+ + +
+ 
<div class="d-lg-none">hide on lg and wider screens</div>
+<div class="d-none d-lg-block">hide on screens smaller than lg</div>
+ +

Display in print

+

Change the display value of elements when printing with our print display utility classes. Includes support for the same display values as our responsive .d-* utilities.

+
    +
  • .d-print-none
    • +
  • .d-print-inline
    • +
  • .d-print-inline-block
    • +
  • .d-print-block
    • +
  • .d-print-grid
    • +
  • .d-print-table
    • +
  • .d-print-table-row
    • +
  • .d-print-table-cell
    • +
  • .d-print-flex
    • +
  • .d-print-inline-flex
    • +
+

The print and display classes can be combined.

+
+
Screen Only (Hide on print only)
+
Print Only (Hide on screen only)
+
Hide up to large on screen, but always show on print
+
+ html +
+ + +
+ 
<div class="d-print-none">Screen Only (Hide on print only)</div>
+<div class="d-none d-print-block">Print Only (Hide on screen only)</div>
+<div class="d-none d-lg-block d-print-block">Hide up to large on screen, but always show on print</div>
+ +

Sass

+

Utilities API

+

Display utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "display": (
+      responsive: true,
+      print: true,
+      property: display,
+      class: d,
+      values: inline inline-block block grid table table-row table-cell flex inline-flex none
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/flex/index.html b/docs/5.3/utilities/flex/index.html new file mode 100644 index 0000000000..0fe9c7d7cf --- /dev/null +++ b/docs/5.3/utilities/flex/index.html @@ -0,0 +1,1729 @@ + + + + + + + + + + + + +Flex · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Flex

+
+

Quickly manage the layout, alignment, and sizing of grid columns, navigation, components, and more with a full suite of responsive flexbox utilities. For more complex implementations, custom CSS may be necessary.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Enable flex behaviors

+

Apply display utilities to create a flexbox container and transform direct children elements into flex items. Flex containers and items are able to be modified further with additional flex properties.

+
+
I'm a flexbox container!
+
+ html +
+ + +
+ 
<div class="d-flex p-2">I'm a flexbox container!</div>
+ +
+
I'm an inline flexbox container!
+
+ html +
+ + +
+ 
<div class="d-inline-flex p-2">I'm an inline flexbox container!</div>
+ +

Responsive variations also exist for .d-flex and .d-inline-flex.

+
    +
  • .d-flex
    • +
  • .d-inline-flex
    • +
  • .d-sm-flex
    • +
  • .d-sm-inline-flex
    • +
  • .d-md-flex
    • +
  • .d-md-inline-flex
    • +
  • .d-lg-flex
    • +
  • .d-lg-inline-flex
    • +
  • .d-xl-flex
    • +
  • .d-xl-inline-flex
    • +
  • .d-xxl-flex
    • +
  • .d-xxl-inline-flex
    • +
+ +

Direction

+

Set the direction of flex items in a flex container with direction utilities. In most cases you can omit the horizontal class here as the browser default is row. However, you may encounter situations where you needed to explicitly set this value (like responsive layouts).

+

Use .flex-row to set a horizontal direction (the browser default), or .flex-row-reverse to start the horizontal direction from the opposite side.

+
+
+
Flex item 1
+
Flex item 2
+
Flex item 3
+
+
+
Flex item 1
+
Flex item 2
+
Flex item 3
+
+
+ html +
+ + +
+ 
<div class="d-flex flex-row mb-3">
+  <div class="p-2">Flex item 1</div>
+  <div class="p-2">Flex item 2</div>
+  <div class="p-2">Flex item 3</div>
+</div>
+<div class="d-flex flex-row-reverse">
+  <div class="p-2">Flex item 1</div>
+  <div class="p-2">Flex item 2</div>
+  <div class="p-2">Flex item 3</div>
+</div>
+ +

Use .flex-column to set a vertical direction, or .flex-column-reverse to start the vertical direction from the opposite side.

+
+
+
Flex item 1
+
Flex item 2
+
Flex item 3
+
+
+
Flex item 1
+
Flex item 2
+
Flex item 3
+
+
+ html +
+ + +
+ 
<div class="d-flex flex-column mb-3">
+  <div class="p-2">Flex item 1</div>
+  <div class="p-2">Flex item 2</div>
+  <div class="p-2">Flex item 3</div>
+</div>
+<div class="d-flex flex-column-reverse">
+  <div class="p-2">Flex item 1</div>
+  <div class="p-2">Flex item 2</div>
+  <div class="p-2">Flex item 3</div>
+</div>
+ +

Responsive variations also exist for flex-direction.

+
    +
  • .flex-row
    • +
  • .flex-row-reverse
    • +
  • .flex-column
    • +
  • .flex-column-reverse
    • +
  • .flex-sm-row
    • +
  • .flex-sm-row-reverse
    • +
  • .flex-sm-column
    • +
  • .flex-sm-column-reverse
    • +
  • .flex-md-row
    • +
  • .flex-md-row-reverse
    • +
  • .flex-md-column
    • +
  • .flex-md-column-reverse
    • +
  • .flex-lg-row
    • +
  • .flex-lg-row-reverse
    • +
  • .flex-lg-column
    • +
  • .flex-lg-column-reverse
    • +
  • .flex-xl-row
    • +
  • .flex-xl-row-reverse
    • +
  • .flex-xl-column
    • +
  • .flex-xl-column-reverse
    • +
  • .flex-xxl-row
    • +
  • .flex-xxl-row-reverse
    • +
  • .flex-xxl-column
    • +
  • .flex-xxl-column-reverse
    • +
+ +

Justify content

+

Use justify-content utilities on flexbox containers to change the alignment of flex items on the main axis (the x-axis to start, y-axis if flex-direction: column). Choose from start (browser default), end, center, between, around, or evenly.

+
+
+
Flex item
+
Flex item
+
Flex item
+
+
+
Flex item
+
Flex item
+
Flex item
+
+
+
Flex item
+
Flex item
+
Flex item
+
+
+
Flex item
+
Flex item
+
Flex item
+
+
+
Flex item
+
Flex item
+
Flex item
+
+
+
Flex item
+
Flex item
+
Flex item
+
+
+
<div class="d-flex justify-content-start">...</div>
+<div class="d-flex justify-content-end">...</div>
+<div class="d-flex justify-content-center">...</div>
+<div class="d-flex justify-content-between">...</div>
+<div class="d-flex justify-content-around">...</div>
+<div class="d-flex justify-content-evenly">...</div>
+

Responsive variations also exist for justify-content.

+
    +
  • .justify-content-start
    • +
  • .justify-content-end
    • +
  • .justify-content-center
    • +
  • .justify-content-between
    • +
  • .justify-content-around
    • +
  • .justify-content-evenly
    • +
  • .justify-content-sm-start
    • +
  • .justify-content-sm-end
    • +
  • .justify-content-sm-center
    • +
  • .justify-content-sm-between
    • +
  • .justify-content-sm-around
    • +
  • .justify-content-sm-evenly
    • +
  • .justify-content-md-start
    • +
  • .justify-content-md-end
    • +
  • .justify-content-md-center
    • +
  • .justify-content-md-between
    • +
  • .justify-content-md-around
    • +
  • .justify-content-md-evenly
    • +
  • .justify-content-lg-start
    • +
  • .justify-content-lg-end
    • +
  • .justify-content-lg-center
    • +
  • .justify-content-lg-between
    • +
  • .justify-content-lg-around
    • +
  • .justify-content-lg-evenly
    • +
  • .justify-content-xl-start
    • +
  • .justify-content-xl-end
    • +
  • .justify-content-xl-center
    • +
  • .justify-content-xl-between
    • +
  • .justify-content-xl-around
    • +
  • .justify-content-xl-evenly
    • +
  • .justify-content-xxl-start
    • +
  • .justify-content-xxl-end
    • +
  • .justify-content-xxl-center
    • +
  • .justify-content-xxl-between
    • +
  • .justify-content-xxl-around
    • +
  • .justify-content-xxl-evenly
    • +
+ +

Align items

+

Use align-items utilities on flexbox containers to change the alignment of flex items on the cross axis (the y-axis to start, x-axis if flex-direction: column). Choose from start, end, center, baseline, or stretch (browser default).

+
+
+
Flex item
+
Flex item
+
Flex item
+
+
+
Flex item
+
Flex item
+
Flex item
+
+
+
Flex item
+
Flex item
+
Flex item
+
+
+
Flex item
+
Flex item
+
Flex item
+
+
+
Flex item
+
Flex item
+
Flex item
+
+
+
<div class="d-flex align-items-start">...</div>
+<div class="d-flex align-items-end">...</div>
+<div class="d-flex align-items-center">...</div>
+<div class="d-flex align-items-baseline">...</div>
+<div class="d-flex align-items-stretch">...</div>
+

Responsive variations also exist for align-items.

+
    +
  • .align-items-start
    • +
  • .align-items-end
    • +
  • .align-items-center
    • +
  • .align-items-baseline
    • +
  • .align-items-stretch
    • +
  • .align-items-sm-start
    • +
  • .align-items-sm-end
    • +
  • .align-items-sm-center
    • +
  • .align-items-sm-baseline
    • +
  • .align-items-sm-stretch
    • +
  • .align-items-md-start
    • +
  • .align-items-md-end
    • +
  • .align-items-md-center
    • +
  • .align-items-md-baseline
    • +
  • .align-items-md-stretch
    • +
  • .align-items-lg-start
    • +
  • .align-items-lg-end
    • +
  • .align-items-lg-center
    • +
  • .align-items-lg-baseline
    • +
  • .align-items-lg-stretch
    • +
  • .align-items-xl-start
    • +
  • .align-items-xl-end
    • +
  • .align-items-xl-center
    • +
  • .align-items-xl-baseline
    • +
  • .align-items-xl-stretch
    • +
  • .align-items-xxl-start
    • +
  • .align-items-xxl-end
    • +
  • .align-items-xxl-center
    • +
  • .align-items-xxl-baseline
    • +
  • .align-items-xxl-stretch
    • +
+ +

Align self

+

Use align-self utilities on flexbox items to individually change their alignment on the cross axis (the y-axis to start, x-axis if flex-direction: column). Choose from the same options as align-items: start, end, center, baseline, or stretch (browser default).

+
+
+
Flex item
+
Aligned flex item
+
Flex item
+
+
+
Flex item
+
Aligned flex item
+
Flex item
+
+
+
Flex item
+
Aligned flex item
+
Flex item
+
+
+
Flex item
+
Aligned flex item
+
Flex item
+
+
+
Flex item
+
Aligned flex item
+
Flex item
+
+
+
<div class="align-self-start">Aligned flex item</div>
+<div class="align-self-end">Aligned flex item</div>
+<div class="align-self-center">Aligned flex item</div>
+<div class="align-self-baseline">Aligned flex item</div>
+<div class="align-self-stretch">Aligned flex item</div>
+

Responsive variations also exist for align-self.

+
    +
  • .align-self-start
    • +
  • .align-self-end
    • +
  • .align-self-center
    • +
  • .align-self-baseline
    • +
  • .align-self-stretch
    • +
  • .align-self-sm-start
    • +
  • .align-self-sm-end
    • +
  • .align-self-sm-center
    • +
  • .align-self-sm-baseline
    • +
  • .align-self-sm-stretch
    • +
  • .align-self-md-start
    • +
  • .align-self-md-end
    • +
  • .align-self-md-center
    • +
  • .align-self-md-baseline
    • +
  • .align-self-md-stretch
    • +
  • .align-self-lg-start
    • +
  • .align-self-lg-end
    • +
  • .align-self-lg-center
    • +
  • .align-self-lg-baseline
    • +
  • .align-self-lg-stretch
    • +
  • .align-self-xl-start
    • +
  • .align-self-xl-end
    • +
  • .align-self-xl-center
    • +
  • .align-self-xl-baseline
    • +
  • .align-self-xl-stretch
    • +
  • .align-self-xxl-start
    • +
  • .align-self-xxl-end
    • +
  • .align-self-xxl-center
    • +
  • .align-self-xxl-baseline
    • +
  • .align-self-xxl-stretch
    • +
+ +

Fill

+

Use the .flex-fill class on a series of sibling elements to force them into widths equal to their content (or equal widths if their content does not surpass their border-boxes) while taking up all available horizontal space.

+
+
+
Flex item with a lot of content
+
Flex item
+
Flex item
+
+
+ html +
+ + +
+ 
<div class="d-flex">
+  <div class="p-2 flex-fill">Flex item with a lot of content</div>
+  <div class="p-2 flex-fill">Flex item</div>
+  <div class="p-2 flex-fill">Flex item</div>
+</div>
+ +

Responsive variations also exist for flex-fill.

+
    +
  • .flex-fill
    • +
  • .flex-sm-fill
    • +
  • .flex-md-fill
    • +
  • .flex-lg-fill
    • +
  • .flex-xl-fill
    • +
  • .flex-xxl-fill
    • +
+ +

Grow and shrink

+

Use .flex-grow-* utilities to toggle a flex item’s ability to grow to fill available space. In the example below, the .flex-grow-1 elements uses all available space it can, while allowing the remaining two flex items their necessary space.

+
+
+
Flex item
+
Flex item
+
Third flex item
+
+
+ html +
+ + +
+ 
<div class="d-flex">
+  <div class="p-2 flex-grow-1">Flex item</div>
+  <div class="p-2">Flex item</div>
+  <div class="p-2">Third flex item</div>
+</div>
+ +

Use .flex-shrink-* utilities to toggle a flex item’s ability to shrink if necessary. In the example below, the second flex item with .flex-shrink-1 is forced to wrap its contents to a new line, “shrinking” to allow more space for the previous flex item with .w-100.

+
+
+
Flex item
+
Flex item
+
+
+ html +
+ + +
+ 
<div class="d-flex">
+  <div class="p-2 w-100">Flex item</div>
+  <div class="p-2 flex-shrink-1">Flex item</div>
+</div>
+ +

Responsive variations also exist for flex-grow and flex-shrink.

+
    +
  • .flex-{grow|shrink}-0
    • +
  • .flex-{grow|shrink}-1
    • +
  • .flex-sm-{grow|shrink}-0
    • +
  • .flex-sm-{grow|shrink}-1
    • +
  • .flex-md-{grow|shrink}-0
    • +
  • .flex-md-{grow|shrink}-1
    • +
  • .flex-lg-{grow|shrink}-0
    • +
  • .flex-lg-{grow|shrink}-1
    • +
  • .flex-xl-{grow|shrink}-0
    • +
  • .flex-xl-{grow|shrink}-1
    • +
  • .flex-xxl-{grow|shrink}-0
    • +
  • .flex-xxl-{grow|shrink}-1
    • +
+ +

Auto margins

+

Flexbox can do some pretty awesome things when you mix flex alignments with auto margins. Shown below are three examples of controlling flex items via auto margins: default (no auto margin), pushing two items to the right (.me-auto), and pushing two items to the left (.ms-auto).

+
+
+
Flex item
+
Flex item
+
Flex item
+
+ +
+
Flex item
+
Flex item
+
Flex item
+
+ +
+
Flex item
+
Flex item
+
Flex item
+
+
+ html +
+ + +
+ 
<div class="d-flex mb-3">
+  <div class="p-2">Flex item</div>
+  <div class="p-2">Flex item</div>
+  <div class="p-2">Flex item</div>
+</div>
+
+<div class="d-flex mb-3">
+  <div class="me-auto p-2">Flex item</div>
+  <div class="p-2">Flex item</div>
+  <div class="p-2">Flex item</div>
+</div>
+
+<div class="d-flex mb-3">
+  <div class="p-2">Flex item</div>
+  <div class="p-2">Flex item</div>
+  <div class="ms-auto p-2">Flex item</div>
+</div>
+ +

With align-items

+

Vertically move one flex item to the top or bottom of a container by mixing align-items, flex-direction: column, and margin-top: auto or margin-bottom: auto.

+
+
+
Flex item
+
Flex item
+
Flex item
+
+ +
+
Flex item
+
Flex item
+
Flex item
+
+
+ html +
+ + +
+ 
<div class="d-flex align-items-start flex-column mb-3" style="height: 200px;">
+  <div class="mb-auto p-2">Flex item</div>
+  <div class="p-2">Flex item</div>
+  <div class="p-2">Flex item</div>
+</div>
+
+<div class="d-flex align-items-end flex-column mb-3" style="height: 200px;">
+  <div class="p-2">Flex item</div>
+  <div class="p-2">Flex item</div>
+  <div class="mt-auto p-2">Flex item</div>
+</div>
+ +

Wrap

+

Change how flex items wrap in a flex container. Choose from no wrapping at all (the browser default) with .flex-nowrap, wrapping with .flex-wrap, or reverse wrapping with .flex-wrap-reverse.

+
+
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
+
+
<div class="d-flex flex-nowrap">
+  ...
+</div>
+
+
+
Flex item 1
+
Flex item 2
+
Flex item 3
+
Flex item 4
+
Flex item 5
+
Flex item 6
+
Flex item 7
+
Flex item 8
+
Flex item 9
+
Flex item 10
+
Flex item 11
+
Flex item 12
+
Flex item 13
+
Flex item 14
+
+
+
<div class="d-flex flex-wrap">
+  ...
+</div>
+
+
+
Flex item 1
+
Flex item 2
+
Flex item 3
+
Flex item 4
+
Flex item 5
+
Flex item 6
+
Flex item 7
+
Flex item 8
+
Flex item 9
+
Flex item 10
+
Flex item 11
+
Flex item 12
+
Flex item 13
+
Flex item 14
+
+
+
<div class="d-flex flex-wrap-reverse">
+  ...
+</div>
+

Responsive variations also exist for flex-wrap.

+
    +
  • .flex-nowrap
    • +
  • .flex-wrap
    • +
  • .flex-wrap-reverse
    • +
  • .flex-sm-nowrap
    • +
  • .flex-sm-wrap
    • +
  • .flex-sm-wrap-reverse
    • +
  • .flex-md-nowrap
    • +
  • .flex-md-wrap
    • +
  • .flex-md-wrap-reverse
    • +
  • .flex-lg-nowrap
    • +
  • .flex-lg-wrap
    • +
  • .flex-lg-wrap-reverse
    • +
  • .flex-xl-nowrap
    • +
  • .flex-xl-wrap
    • +
  • .flex-xl-wrap-reverse
    • +
  • .flex-xxl-nowrap
    • +
  • .flex-xxl-wrap
    • +
  • .flex-xxl-wrap-reverse
    • +
+ +

Order

+

Change the visual order of specific flex items with a handful of order utilities. We only provide options for making an item first or last, as well as a reset to use the DOM order. As order takes any integer value from 0 to 5, add custom CSS for any additional values needed.

+
+
+
First flex item
+
Second flex item
+
Third flex item
+
+
+ html +
+ + +
+ 
<div class="d-flex flex-nowrap">
+  <div class="order-3 p-2">First flex item</div>
+  <div class="order-2 p-2">Second flex item</div>
+  <div class="order-1 p-2">Third flex item</div>
+</div>
+ +

Responsive variations also exist for order.

+
    +
  • .order-0
    • +
  • .order-1
    • +
  • .order-2
    • +
  • .order-3
    • +
  • .order-4
    • +
  • .order-5
    • +
  • .order-sm-0
    • +
  • .order-sm-1
    • +
  • .order-sm-2
    • +
  • .order-sm-3
    • +
  • .order-sm-4
    • +
  • .order-sm-5
    • +
  • .order-md-0
    • +
  • .order-md-1
    • +
  • .order-md-2
    • +
  • .order-md-3
    • +
  • .order-md-4
    • +
  • .order-md-5
    • +
  • .order-lg-0
    • +
  • .order-lg-1
    • +
  • .order-lg-2
    • +
  • .order-lg-3
    • +
  • .order-lg-4
    • +
  • .order-lg-5
    • +
  • .order-xl-0
    • +
  • .order-xl-1
    • +
  • .order-xl-2
    • +
  • .order-xl-3
    • +
  • .order-xl-4
    • +
  • .order-xl-5
    • +
  • .order-xxl-0
    • +
  • .order-xxl-1
    • +
  • .order-xxl-2
    • +
  • .order-xxl-3
    • +
  • .order-xxl-4
    • +
  • .order-xxl-5
    • +
+ +

Additionally there are also responsive .order-first and .order-last classes that change the order of an element by applying order: -1 and order: 6, respectively.

+
    +
  • .order-first
    • +
  • .order-last
    • +
  • .order-sm-first
    • +
  • .order-sm-last
    • +
  • .order-md-first
    • +
  • .order-md-last
    • +
  • .order-lg-first
    • +
  • .order-lg-last
    • +
  • .order-xl-first
    • +
  • .order-xl-last
    • +
  • .order-xxl-first
    • +
  • .order-xxl-last
    • +
+ +

Align content

+

Use align-content utilities on flexbox containers to align flex items together on the cross axis. Choose from start (browser default), end, center, between, around, or stretch. To demonstrate these utilities, we’ve enforced flex-wrap: wrap and increased the number of flex items.

+

Heads up! This property has no effect on single rows of flex items.

+
+
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
+
+
<div class="d-flex align-content-start flex-wrap">
+  ...
+</div>
+
+
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
+
+
<div class="d-flex align-content-end flex-wrap">...</div>
+
+
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
+
+
<div class="d-flex align-content-center flex-wrap">...</div>
+
+
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
+
+
<div class="d-flex align-content-between flex-wrap">...</div>
+
+
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
+
+
<div class="d-flex align-content-around flex-wrap">...</div>
+
+
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
Flex item
+
+
+
<div class="d-flex align-content-stretch flex-wrap">...</div>
+

Responsive variations also exist for align-content.

+
    +
  • .align-content-start
    • +
  • .align-content-end
    • +
  • .align-content-center
    • +
  • .align-content-between
    • +
  • .align-content-around
    • +
  • .align-content-stretch
    • +
  • .align-content-sm-start
    • +
  • .align-content-sm-end
    • +
  • .align-content-sm-center
    • +
  • .align-content-sm-between
    • +
  • .align-content-sm-around
    • +
  • .align-content-sm-stretch
    • +
  • .align-content-md-start
    • +
  • .align-content-md-end
    • +
  • .align-content-md-center
    • +
  • .align-content-md-between
    • +
  • .align-content-md-around
    • +
  • .align-content-md-stretch
    • +
  • .align-content-lg-start
    • +
  • .align-content-lg-end
    • +
  • .align-content-lg-center
    • +
  • .align-content-lg-between
    • +
  • .align-content-lg-around
    • +
  • .align-content-lg-stretch
    • +
  • .align-content-xl-start
    • +
  • .align-content-xl-end
    • +
  • .align-content-xl-center
    • +
  • .align-content-xl-between
    • +
  • .align-content-xl-around
    • +
  • .align-content-xl-stretch
    • +
  • .align-content-xxl-start
    • +
  • .align-content-xxl-end
    • +
  • .align-content-xxl-center
    • +
  • .align-content-xxl-between
    • +
  • .align-content-xxl-around
    • +
  • .align-content-xxl-stretch
    • +
+ +

Media object

+

Looking to replicate the media object component from Bootstrap 4? Recreate it in no time with a few flex utilities that allow even more flexibility and customization than before.

+
+
+
+ PlaceholderImage +
+
+ This is some content from a media component. You can replace this with any content and adjust it as needed. +
+
+
+ html +
+ + +
+ 
<div class="d-flex">
+  <div class="flex-shrink-0">
+    <img src="..." alt="...">
+  </div>
+  <div class="flex-grow-1 ms-3">
+    This is some content from a media component. You can replace this with any content and adjust it as needed.
+  </div>
+</div>
+ +

And say you want to vertically center the content next to the image:

+
+
+
+ PlaceholderImage +
+
+ This is some content from a media component. You can replace this with any content and adjust it as needed. +
+
+
+ html +
+ + +
+ 
<div class="d-flex align-items-center">
+  <div class="flex-shrink-0">
+    <img src="..." alt="...">
+  </div>
+  <div class="flex-grow-1 ms-3">
+    This is some content from a media component. You can replace this with any content and adjust it as needed.
+  </div>
+</div>
+ +

Sass

+

Utilities API

+

Flexbox utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "flex": (
+      responsive: true,
+      property: flex,
+      values: (fill: 1 1 auto)
+    ),
+    "flex-direction": (
+      responsive: true,
+      property: flex-direction,
+      class: flex,
+      values: row column row-reverse column-reverse
+    ),
+    "flex-grow": (
+      responsive: true,
+      property: flex-grow,
+      class: flex,
+      values: (
+        grow-0: 0,
+        grow-1: 1,
+      )
+    ),
+    "flex-shrink": (
+      responsive: true,
+      property: flex-shrink,
+      class: flex,
+      values: (
+        shrink-0: 0,
+        shrink-1: 1,
+      )
+    ),
+    "flex-wrap": (
+      responsive: true,
+      property: flex-wrap,
+      class: flex,
+      values: wrap nowrap wrap-reverse
+    ),
+    "justify-content": (
+      responsive: true,
+      property: justify-content,
+      values: (
+        start: flex-start,
+        end: flex-end,
+        center: center,
+        between: space-between,
+        around: space-around,
+        evenly: space-evenly,
+      )
+    ),
+    "align-items": (
+      responsive: true,
+      property: align-items,
+      values: (
+        start: flex-start,
+        end: flex-end,
+        center: center,
+        baseline: baseline,
+        stretch: stretch,
+      )
+    ),
+    "align-content": (
+      responsive: true,
+      property: align-content,
+      values: (
+        start: flex-start,
+        end: flex-end,
+        center: center,
+        between: space-between,
+        around: space-around,
+        stretch: stretch,
+      )
+    ),
+    "align-self": (
+      responsive: true,
+      property: align-self,
+      values: (
+        auto: auto,
+        start: flex-start,
+        end: flex-end,
+        center: center,
+        baseline: baseline,
+        stretch: stretch,
+      )
+    ),
+    "order": (
+      responsive: true,
+      property: order,
+      values: (
+        first: -1,
+        0: 0,
+        1: 1,
+        2: 2,
+        3: 3,
+        4: 4,
+        5: 5,
+        last: 6,
+      ),
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/float/index.html b/docs/5.3/utilities/float/index.html new file mode 100644 index 0000000000..b90f1c5815 --- /dev/null +++ b/docs/5.3/utilities/float/index.html @@ -0,0 +1,773 @@ + + + + + + + + + + + + +Float · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Float

+
+

Toggle floats on any element, across any breakpoint, using our responsive float utilities.

+ + +
+ + +
+ + On this page +
+
+ +
+
+ + +
+ + +

Overview

+

These utility classes float an element to the left or right, or disable floating, based on the current viewport size using the CSS float property. !important is included to avoid specificity issues. These use the same viewport breakpoints as our grid system. Please be aware float utilities have no effect on flex items.

+
+
Float start on all viewport sizes

+
Float end on all viewport sizes

+
Don't float on all viewport sizes
+
+ html +
+ + +
+ 
<div class="float-start">Float start on all viewport sizes</div><br>
+<div class="float-end">Float end on all viewport sizes</div><br>
+<div class="float-none">Don't float on all viewport sizes</div>
+ +

Responsive

+

Responsive variations also exist for each float value.

+
+
Float start on viewports sized SM (small) or wider

+
Float start on viewports sized MD (medium) or wider

+
Float start on viewports sized LG (large) or wider

+
Float start on viewports sized XL (extra-large) or wider

+
+ html +
+ + +
+ 
<div class="float-sm-start">Float start on viewports sized SM (small) or wider</div><br>
+<div class="float-md-start">Float start on viewports sized MD (medium) or wider</div><br>
+<div class="float-lg-start">Float start on viewports sized LG (large) or wider</div><br>
+<div class="float-xl-start">Float start on viewports sized XL (extra-large) or wider</div><br>
+ +

Here are all the support classes:

+
    +
  • .float-start
    • +
  • .float-end
    • +
  • .float-none
    • +
  • .float-sm-start
    • +
  • .float-sm-end
    • +
  • .float-sm-none
    • +
  • .float-md-start
    • +
  • .float-md-end
    • +
  • .float-md-none
    • +
  • .float-lg-start
    • +
  • .float-lg-end
    • +
  • .float-lg-none
    • +
  • .float-xl-start
    • +
  • .float-xl-end
    • +
  • .float-xl-none
    • +
  • .float-xxl-start
    • +
  • .float-xxl-end
    • +
  • .float-xxl-none
    • +
+ +

Sass

+

Utilities API

+

Float utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "float": (
+      responsive: true,
+      property: float,
+      values: (
+        start: left,
+        end: right,
+        none: none,
+      )
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/index.html b/docs/5.3/utilities/index.html new file mode 100644 index 0000000000..1cf1d97f53 --- /dev/null +++ b/docs/5.3/utilities/index.html @@ -0,0 +1,12 @@ + + + + + + https://getbootstrap.com/docs/5.3/utilities/api/ + + + + + + diff --git a/docs/5.3/utilities/interactions/index.html b/docs/5.3/utilities/interactions/index.html new file mode 100644 index 0000000000..f40446dcac --- /dev/null +++ b/docs/5.3/utilities/interactions/index.html @@ -0,0 +1,733 @@ + + + + + + + + + + + + +Interactions · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Interactions

+
+

Utility classes that change how users interact with contents of a website.

+ + +
+ + + +
+ + +

Text selection

+

Change the way in which the content is selected when the user interacts with it.

+
+

This paragraph will be entirely selected when clicked by the user.

+

This paragraph has default select behavior.

+

This paragraph will not be selectable when clicked by the user.

+
+ html +
+ + +
+ 
<p class="user-select-all">This paragraph will be entirely selected when clicked by the user.</p>
+<p class="user-select-auto">This paragraph has default select behavior.</p>
+<p class="user-select-none">This paragraph will not be selectable when clicked by the user.</p>
+ +

Pointer events

+

Bootstrap provides .pe-none and .pe-auto classes to prevent or add element interactions.

+
+

This link can not be clicked.

+

This link can be clicked (this is default behavior).

+

This link can not be clicked because the pointer-events property is inherited from its parent. However, this link has a pe-auto class and can be clicked.

+
+ html +
+ + +
+ 
<p><a href="#" class="pe-none" tabindex="-1" aria-disabled="true">This link</a> can not be clicked.</p>
+<p><a href="#" class="pe-auto">This link</a> can be clicked (this is default behavior).</p>
+<p class="pe-none"><a href="#" tabindex="-1" aria-disabled="true">This link</a> can not be clicked because the <code>pointer-events</code> property is inherited from its parent. However, <a href="#" class="pe-auto">this link</a> has a <code>pe-auto</code> class and can be clicked.</p>
+ +

The .pe-none class (and the pointer-events CSS property it sets) only prevents interactions with a pointer (mouse, stylus, touch). Links and controls with .pe-none are, by default, still focusable and actionable for keyboard users. To ensure that they are completely neutralized even for keyboard users, you may need to add further attributes such as tabindex="-1" (to prevent them from receiving keyboard focus) and aria-disabled="true" (to convey the fact they are effectively disabled to assistive technologies), and possibly use JavaScript to completely prevent them from being actionable.

+

If possible, the simpler solution is:

+
    +
  • For form controls, add the disabled HTML attribute.
    • +
  • For links, remove the href attribute, making it a non-interactive anchor or placeholder link.
    • +
+

Sass

+

Utilities API

+

Interaction utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "user-select": (
+      property: user-select,
+      values: all auto none
+    ),
+    "pointer-events": (
+      property: pointer-events,
+      class: pe,
+      values: none auto,
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/object-fit/index.html b/docs/5.3/utilities/object-fit/index.html new file mode 100644 index 0000000000..ca78e460eb --- /dev/null +++ b/docs/5.3/utilities/object-fit/index.html @@ -0,0 +1,773 @@ + + + + + + + + + + + + +Object fit · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Object fit

+
+

Use the object fit utilities to modify how the content of a replaced element, such as an <img> or <video>, should be resized to fit its container.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

How it works

+

Change the value of the object-fit property with our responsive object-fit utility classes. This property tells the content to fill the parent container in a variety of ways, such as preserving the aspect ratio or stretching to take up as much space as possible.

+

Classes for the value of object-fit are named using the format .object-fit-{value}. Choose from the following values:

+
    +
  • contain
    • +
  • cover
    • +
  • fill
    • +
  • scale (for scale-down)
    • +
  • none
    • +
+

Examples

+

Add the object-fit-{value} class to the replaced element:

+
+Placeholder : Object fit contain +Placeholder : Object fit cover +Placeholder : Object fit fill +Placeholder : Object fit scale down +Placeholder : Object fit none +
+ html +
+ + +
+ 
<img src="..." class="object-fit-contain border rounded" alt="...">
+<img src="..." class="object-fit-cover border rounded" alt="...">
+<img src="..." class="object-fit-fill border rounded" alt="...">
+<img src="..." class="object-fit-scale border rounded" alt="...">
+<img src="..." class="object-fit-none border rounded" alt="...">
+ +

Responsive

+

Responsive variations also exist for each object-fit value using the format .object-fit-{breakpoint}-{value}, for the following breakpoint abbreviations: sm, md, lg, xl, and xxl. Classes can be combined for various effects as you need.

+
+Placeholder : Contain on sm +Placeholder : Contain on md +Placeholder : Contain on lg +Placeholder : Contain on xl +Placeholder : Contain on xxl +
+ html +
+ + +
+ 
<img src="..." class="object-fit-sm-contain border rounded" alt="...">
+<img src="..." class="object-fit-md-contain border rounded" alt="...">
+<img src="..." class="object-fit-lg-contain border rounded" alt="...">
+<img src="..." class="object-fit-xl-contain border rounded" alt="...">
+<img src="..." class="object-fit-xxl-contain border rounded" alt="...">
+ +

Video

+

The .object-fit-{value} and responsive .object-fit-{breakpoint}-{value} utilities also work on <video> elements.

+
<video src="..." class="object-fit-contain" autoplay></video>
+<video src="..." class="object-fit-cover" autoplay></video>
+<video src="..." class="object-fit-fill" autoplay></video>
+<video src="..." class="object-fit-scale" autoplay></video>
+<video src="..." class="object-fit-none" autoplay></video>
+

Utilities API

+

Object fit utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "object-fit": (
+      responsive: true,
+      property: object-fit,
+      values: (
+        contain: contain,
+        cover: cover,
+        fill: fill,
+        scale: scale-down,
+        none: none,
+      )
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/opacity/index.html b/docs/5.3/utilities/opacity/index.html new file mode 100644 index 0000000000..9a80c38b5b --- /dev/null +++ b/docs/5.3/utilities/opacity/index.html @@ -0,0 +1,699 @@ + + + + + + + + + + + + +Opacity · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
Added in v5.1 + View on GitHub + +
+

Opacity

+
+

Control the opacity of elements.

+ + +
+ + + +
+ + +

The opacity property sets the opacity level for an element. The opacity level describes the transparency level, where 1 is not transparent at all, .5 is 50% visible, and 0 is completely transparent.

+

Set the opacity of an element using .opacity-{value} utilities.

+
+
100%
+
75%
+
50%
+
25%
+
+
<div class="opacity-100">...</div>
+<div class="opacity-75">...</div>
+<div class="opacity-50">...</div>
+<div class="opacity-25">...</div>
+

Utilities API

+

Opacity utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "opacity": (
+      property: opacity,
+      values: (
+        0: 0,
+        25: .25,
+        50: .5,
+        75: .75,
+        100: 1,
+      )
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/overflow/index.html b/docs/5.3/utilities/overflow/index.html new file mode 100644 index 0000000000..10d32d7766 --- /dev/null +++ b/docs/5.3/utilities/overflow/index.html @@ -0,0 +1,781 @@ + + + + + + + + + + + + +Overflow · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Overflow

+
+

Use these shorthand utilities for quickly configuring how content overflows an element.

+ + +
+ + +
+ + On this page +
+
+ +
+
+ + +
+ + +

Overflow

+

Adjust the overflow property on the fly with four default values and classes. These classes are not responsive by default.

+
+
+ This is an example of using .overflow-auto on an element with set width and height dimensions. By design, this content will vertically scroll. +
+
+ This is an example of using .overflow-hidden on an element with set width and height dimensions. +
+
+ This is an example of using .overflow-visible on an element with set width and height dimensions. +
+
+ This is an example of using .overflow-scroll on an element with set width and height dimensions. +
+
+
<div class="overflow-auto">...</div>
+<div class="overflow-hidden">...</div>
+<div class="overflow-visible">...</div>
+<div class="overflow-scroll">...</div>
+

overflow-x

+

Adjust the overflow-x property to affect the overflow of content horizontally.

+
+
+
.overflow-x-auto example on an element
+
with set width and height dimensions.
+
+
+
.overflow-x-hidden example
+
on an element with set width and height dimensions.
+
+
+
.overflow-x-visible example
+
on an element with set width and height dimensions.
+
+
+
.overflow-x-scroll example on an element
+
with set width and height dimensions.
+
+
+
<div class="overflow-x-auto">...</div>
+<div class="overflow-x-hidden">...</div>
+<div class="overflow-x-visible">...</div>
+<div class="overflow-x-scroll">...</div>
+

overflow-y

+

Adjust the overflow-y property to affect the overflow of content vertically.

+
+
+ .overflow-y-auto example on an element with set width and height dimensions. +
+
+ .overflow-y-hidden example on an element with set width and height dimensions. +
+
+ .overflow-y-visible example on an element with set width and height dimensions. +
+
+ .overflow-y-scroll example on an element with set width and height dimensions. +
+
+
<div class="overflow-y-auto">...</div>
+<div class="overflow-y-hidden">...</div>
+<div class="overflow-y-visible">...</div>
+<div class="overflow-y-scroll">...</div>
+

Using Sass variables, you may customize the overflow utilities by changing the $overflows variable in _variables.scss.

+

Sass

+

Utilities API

+

Overflow utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "overflow": (
+      property: overflow,
+      values: auto hidden visible scroll,
+    ),
+    "overflow-x": (
+      property: overflow-x,
+      values: auto hidden visible scroll,
+    ),
+    "overflow-y": (
+      property: overflow-y,
+      values: auto hidden visible scroll,
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/position/index.html b/docs/5.3/utilities/position/index.html new file mode 100644 index 0000000000..fc100061fc --- /dev/null +++ b/docs/5.3/utilities/position/index.html @@ -0,0 +1,930 @@ + + + + + + + + + + + + +Position · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Position

+
+

Use these shorthand utilities for quickly configuring the position of an element.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Position values

+

Quick positioning classes are available, though they are not responsive.

+
<div class="position-static">...</div>
+<div class="position-relative">...</div>
+<div class="position-absolute">...</div>
+<div class="position-fixed">...</div>
+<div class="position-sticky">...</div>
+

Arrange elements

+

Arrange elements easily with the edge positioning utilities. The format is {property}-{position}.

+

Where property is one of:

+
    +
  • top - for the vertical top position
    • +
  • start - for the horizontal left position (in LTR)
    • +
  • bottom - for the vertical bottom position
    • +
  • end - for the horizontal right position (in LTR)
    • +
+

Where position is one of:

+
    +
  • 0 - for 0 edge position
    • +
  • 50 - for 50% edge position
    • +
  • 100 - for 100% edge position
    • +
+

(You can add more position values by adding entries to the $position-values Sass map variable.)

+
+
+
+
+
+
+
+
+
+
+ html +
+ + +
+ 
<div class="position-relative">
+  <div class="position-absolute top-0 start-0"></div>
+  <div class="position-absolute top-0 end-0"></div>
+  <div class="position-absolute top-50 start-50"></div>
+  <div class="position-absolute bottom-50 end-50"></div>
+  <div class="position-absolute bottom-0 start-0"></div>
+  <div class="position-absolute bottom-0 end-0"></div>
+</div>
+ +

Center elements

+

In addition, you can also center the elements with the transform utility class .translate-middle.

+

This class applies the transformations translateX(-50%) and translateY(-50%) to the element which, in combination with the edge positioning utilities, allows you to absolute center an element.

+
+
+
+
+
+
+
+
+
+
+
+
+
+ html +
+ + +
+ 
<div class="position-relative">
+  <div class="position-absolute top-0 start-0 translate-middle"></div>
+  <div class="position-absolute top-0 start-50 translate-middle"></div>
+  <div class="position-absolute top-0 start-100 translate-middle"></div>
+  <div class="position-absolute top-50 start-0 translate-middle"></div>
+  <div class="position-absolute top-50 start-50 translate-middle"></div>
+  <div class="position-absolute top-50 start-100 translate-middle"></div>
+  <div class="position-absolute top-100 start-0 translate-middle"></div>
+  <div class="position-absolute top-100 start-50 translate-middle"></div>
+  <div class="position-absolute top-100 start-100 translate-middle"></div>
+</div>
+ +

By adding .translate-middle-x or .translate-middle-y classes, elements can be positioned only in horizontal or vertical direction.

+
+
+
+
+
+
+
+
+
+
+
+
+
+ html +
+ + +
+ 
<div class="position-relative">
+  <div class="position-absolute top-0 start-0"></div>
+  <div class="position-absolute top-0 start-50 translate-middle-x"></div>
+  <div class="position-absolute top-0 end-0"></div>
+  <div class="position-absolute top-50 start-0 translate-middle-y"></div>
+  <div class="position-absolute top-50 start-50 translate-middle"></div>
+  <div class="position-absolute top-50 end-0 translate-middle-y"></div>
+  <div class="position-absolute bottom-0 start-0"></div>
+  <div class="position-absolute bottom-0 start-50 translate-middle-x"></div>
+  <div class="position-absolute bottom-0 end-0"></div>
+</div>
+ +

Examples

+

Here are some real life examples of these classes:

+
+ + +
+ Marker +
+ + +
+ html +
+ + +
+ 
<button type="button" class="btn btn-primary position-relative">
+  Mails <span class="position-absolute top-0 start-100 translate-middle badge rounded-pill bg-secondary">+99 <span class="visually-hidden">unread messages</span></span>
+</button>
+
+<div class="position-relative py-2 px-4 text-bg-dark border border-dark rounded-pill">
+  Marker <svg width="1em" height="1em" viewBox="0 0 16 16" class="position-absolute top-100 start-50 translate-middle mt-1" fill="var(--bs-dark)" xmlns="http://www.w3.org/2000/svg"><path d="M7.247 11.14L2.451 5.658C1.885 5.013 2.345 4 3.204 4h9.592a1 1 0 0 1 .753 1.659l-4.796 5.48a1 1 0 0 1-1.506 0z"/></svg>
+</div>
+
+<button type="button" class="btn btn-primary position-relative">
+  Alerts <span class="position-absolute top-0 start-100 translate-middle badge border border-light rounded-circle bg-danger p-2"><span class="visually-hidden">unread messages</span></span>
+</button>
+ +

You can use these classes with existing components to create new ones. Remember that you can extend its functionality by adding entries to the $position-values variable.

+
+
+
+
+
+ + + +
+
+ html +
+ + +
+ 
<div class="position-relative m-4">
+  <div class="progress" role="progressbar" aria-label="Progress" aria-valuenow="50" aria-valuemin="0" aria-valuemax="100" style="height: 1px;">
+    <div class="progress-bar" style="width: 50%"></div>
+  </div>
+  <button type="button" class="position-absolute top-0 start-0 translate-middle btn btn-sm btn-primary rounded-pill" style="width: 2rem; height:2rem;">1</button>
+  <button type="button" class="position-absolute top-0 start-50 translate-middle btn btn-sm btn-primary rounded-pill" style="width: 2rem; height:2rem;">2</button>
+  <button type="button" class="position-absolute top-0 start-100 translate-middle btn btn-sm btn-secondary rounded-pill" style="width: 2rem; height:2rem;">3</button>
+</div>
+ +

Sass

+

Maps

+

Default position utility values are declared in a Sass map, then used to generate our utilities.

+
$position-values: (
+  0: 0,
+  50: 50%,
+  100: 100%
+);
+
+

Utilities API

+

Position utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "position": (
+      property: position,
+      values: static relative absolute fixed sticky
+    ),
+    "top": (
+      property: top,
+      values: $position-values
+    ),
+    "bottom": (
+      property: bottom,
+      values: $position-values
+    ),
+    "start": (
+      property: left,
+      class: start,
+      values: $position-values
+    ),
+    "end": (
+      property: right,
+      class: end,
+      values: $position-values
+    ),
+    "translate-middle": (
+      property: transform,
+      class: translate-middle,
+      values: (
+        null: translate(-50%, -50%),
+        x: translateX(-50%),
+        y: translateY(-50%),
+      )
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/shadows/index.html b/docs/5.3/utilities/shadows/index.html new file mode 100644 index 0000000000..7c3d7871e7 --- /dev/null +++ b/docs/5.3/utilities/shadows/index.html @@ -0,0 +1,738 @@ + + + + + + + + + + + + +Shadows · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Shadows

+
+

Add or remove shadows to elements with box-shadow utilities.

+ + +
+ + +
+ + On this page +
+
+ +
+
+ + +
+ + +

Examples

+

While shadows on components are disabled by default in Bootstrap and can be enabled via $enable-shadows, you can also quickly add or remove a shadow with our box-shadow utility classes. Includes support for .shadow-none and three default sizes (which have associated variables to match).

+
+
No shadow
+
Small shadow
+
Regular shadow
+
Larger shadow
+
+ html +
+ + +
+ 
<div class="shadow-none p-3 mb-5 bg-body-tertiary rounded">No shadow</div>
+<div class="shadow-sm p-3 mb-5 bg-body-tertiary rounded">Small shadow</div>
+<div class="shadow p-3 mb-5 bg-body-tertiary rounded">Regular shadow</div>
+<div class="shadow-lg p-3 mb-5 bg-body-tertiary rounded">Larger shadow</div>
+ +

Sass

+

Variables

+
$box-shadow:                  0 .5rem 1rem rgba(var(--#{$prefix}body-color-rgb), .15);
+$box-shadow-sm:               0 .125rem .25rem rgba(var(--#{$prefix}body-color-rgb), .075);
+$box-shadow-lg:               0 1rem 3rem rgba(var(--#{$prefix}body-color-rgb), .175);
+$box-shadow-inset:            inset 0 1px 2px rgba(var(--#{$prefix}body-color-rgb), .075);
+
+

Utilities API

+

Shadow utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "shadow": (
+      property: box-shadow,
+      class: shadow,
+      values: (
+        null: $box-shadow,
+        sm: $box-shadow-sm,
+        lg: $box-shadow-lg,
+        none: none,
+      )
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/sizing/index.html b/docs/5.3/utilities/sizing/index.html new file mode 100644 index 0000000000..5f5daa7a0f --- /dev/null +++ b/docs/5.3/utilities/sizing/index.html @@ -0,0 +1,841 @@ + + + + + + + + + + + + +Sizing · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Sizing

+
+

Easily make an element as wide or as tall with our width and height utilities.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Relative to the parent

+

Width and height utilities are generated from the utility API in _utilities.scss. Includes support for 25%, 50%, 75%, 100%, and auto by default. Modify those values as you need to generate different utilities here.

+
+
Width 25%
+
Width 50%
+
Width 75%
+
Width 100%
+
Width auto
+
+ html +
+ + +
+ 
<div class="w-25 p-3">Width 25%</div>
+<div class="w-50 p-3">Width 50%</div>
+<div class="w-75 p-3">Width 75%</div>
+<div class="w-100 p-3">Width 100%</div>
+<div class="w-auto p-3">Width auto</div>
+ +
+
+
Height 25%
+
Height 50%
+
Height 75%
+
Height 100%
+
Height auto
+
+
+ html +
+ + +
+ 
<div style="height: 100px; background-color: rgba(255,0,0,0.1);">
+  <div class="h-25 d-inline-block" style="width: 120px; background-color: rgba(0,0,255,.1)">Height 25%</div>
+  <div class="h-50 d-inline-block" style="width: 120px; background-color: rgba(0,0,255,.1)">Height 50%</div>
+  <div class="h-75 d-inline-block" style="width: 120px; background-color: rgba(0,0,255,.1)">Height 75%</div>
+  <div class="h-100 d-inline-block" style="width: 120px; background-color: rgba(0,0,255,.1)">Height 100%</div>
+  <div class="h-auto d-inline-block" style="width: 120px; background-color: rgba(0,0,255,.1)">Height auto</div>
+</div>
+ +

You can also use max-width: 100%; and max-height: 100%; utilities as needed.

+
+PlaceholderMax-width 100% +
+ html +
+ + +
+ 
<img src="..." class="mw-100" alt="...">
+ +
+
+
Max-height 100%
+
+
+ html +
+ + +
+ 
<div style="height: 100px; background-color: rgba(255,0,0,.1);">
+  <div class="mh-100" style="width: 100px; height: 200px; background-color: rgba(0,0,255,.1);">Max-height 100%</div>
+</div>
+ +

Relative to the viewport

+

You can also use utilities to set the width and height relative to the viewport.

+
<div class="min-vw-100">Min-width 100vw</div>
+<div class="min-vh-100">Min-height 100vh</div>
+<div class="vw-100">Width 100vw</div>
+<div class="vh-100">Height 100vh</div>
+

Sass

+

Utilities API

+

Sizing utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "width": (
+      property: width,
+      class: w,
+      values: (
+        25: 25%,
+        50: 50%,
+        75: 75%,
+        100: 100%,
+        auto: auto
+      )
+    ),
+    "max-width": (
+      property: max-width,
+      class: mw,
+      values: (100: 100%)
+    ),
+    "viewport-width": (
+      property: width,
+      class: vw,
+      values: (100: 100vw)
+    ),
+    "min-viewport-width": (
+      property: min-width,
+      class: min-vw,
+      values: (100: 100vw)
+    ),
+    "height": (
+      property: height,
+      class: h,
+      values: (
+        25: 25%,
+        50: 50%,
+        75: 75%,
+        100: 100%,
+        auto: auto
+      )
+    ),
+    "max-height": (
+      property: max-height,
+      class: mh,
+      values: (100: 100%)
+    ),
+    "viewport-height": (
+      property: height,
+      class: vh,
+      values: (100: 100vh)
+    ),
+    "min-viewport-height": (
+      property: min-height,
+      class: min-vh,
+      values: (100: 100vh)
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/spacing/index.html b/docs/5.3/utilities/spacing/index.html new file mode 100644 index 0000000000..a924a6f918 --- /dev/null +++ b/docs/5.3/utilities/spacing/index.html @@ -0,0 +1,1020 @@ + + + + + + + + + + + + +Spacing · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Spacing

+
+

Bootstrap includes a wide range of shorthand responsive margin, padding, and gap utility classes to modify an element’s appearance.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Margin and padding

+

Assign responsive-friendly margin or padding values to an element or a subset of its sides with shorthand classes. Includes support for individual properties, all properties, and vertical and horizontal properties. Classes are built from a default Sass map ranging from .25rem to 3rem.

+
+Using the CSS Grid layout module? Consider using the gap utility instead. +
+ +

Notation

+

Spacing utilities that apply to all breakpoints, from xs to xxl, have no breakpoint abbreviation in them. This is because those classes are applied from min-width: 0 and up, and thus are not bound by a media query. The remaining breakpoints, however, do include a breakpoint abbreviation.

+

The classes are named using the format {property}{sides}-{size} for xs and {property}{sides}-{breakpoint}-{size} for sm, md, lg, xl, and xxl.

+

Where property is one of:

+
    +
  • m - for classes that set margin
    • +
  • p - for classes that set padding
    • +
+

Where sides is one of:

+
    +
  • t - for classes that set margin-top or padding-top
    • +
  • b - for classes that set margin-bottom or padding-bottom
    • +
  • s - (start) for classes that set margin-left or padding-left in LTR, margin-right or padding-right in RTL
    • +
  • e - (end) for classes that set margin-right or padding-right in LTR, margin-left or padding-left in RTL
    • +
  • x - for classes that set both *-left and *-right
    • +
  • y - for classes that set both *-top and *-bottom
    • +
  • blank - for classes that set a margin or padding on all 4 sides of the element
    • +
+

Where size is one of:

+
    +
  • 0 - for classes that eliminate the margin or padding by setting it to 0
    • +
  • 1 - (by default) for classes that set the margin or padding to $spacer * .25
    • +
  • 2 - (by default) for classes that set the margin or padding to $spacer * .5
    • +
  • 3 - (by default) for classes that set the margin or padding to $spacer
    • +
  • 4 - (by default) for classes that set the margin or padding to $spacer * 1.5
    • +
  • 5 - (by default) for classes that set the margin or padding to $spacer * 3
    • +
  • auto - for classes that set the margin to auto
    • +
+

(You can add more sizes by adding entries to the $spacers Sass map variable.)

+

Examples

+

Here are some representative examples of these classes:

+
.mt-0 {
+  margin-top: 0 !important;
+}
+
+.ms-1 {
+  margin-left: ($spacer * .25) !important;
+}
+
+.px-2 {
+  padding-left: ($spacer * .5) !important;
+  padding-right: ($spacer * .5) !important;
+}
+
+.p-3 {
+  padding: $spacer !important;
+}
+

Horizontal centering

+

Additionally, Bootstrap also includes an .mx-auto class for horizontally centering fixed-width block level content—that is, content that has display: block and a width set—by setting the horizontal margins to auto.

+
+
+ Centered element +
+
+
<div class="mx-auto" style="width: 200px;">
+  Centered element
+</div>
+

Negative margin

+

In CSS, margin properties can utilize negative values (padding cannot). These negative margins are disabled by default, but can be enabled in Sass by setting $enable-negative-margins: true.

+

The syntax is nearly the same as the default, positive margin utilities, but with the addition of n before the requested size. Here’s an example class that’s the opposite of .mt-1:

+
.mt-n1 {
+  margin-top: -0.25rem !important;
+}
+

Gap

+

When using display: grid or display: flex, you can make use of gap utilities on the parent element. This can save on having to add margin utilities to individual children of a grid or flex container. Gap utilities are responsive by default, and are generated via our utilities API, based on the $spacers Sass map.

+
+
+
Grid item 1
+
Grid item 2
+
Grid item 3
+
Grid item 4
+
+
+ html +
+ + +
+ 
<div class="grid gap-3">
+  <div class="p-2 g-col-6">Grid item 1</div>
+  <div class="p-2 g-col-6">Grid item 2</div>
+  <div class="p-2 g-col-6">Grid item 3</div>
+  <div class="p-2 g-col-6">Grid item 4</div>
+</div>
+ +

Support includes responsive options for all of Bootstrap’s grid breakpoints, as well as six sizes from the $spacers map (0–5). There is no .gap-auto utility class as it’s effectively the same as .gap-0.

+

row-gap

+

row-gap sets the vertical space between children items in the specified container.

+
+
+
Grid item 1
+
Grid item 2
+
Grid item 3
+
Grid item 4
+
+
+ html +
+ + +
+ 
<div class="grid gap-0 row-gap-3">
+  <div class="p-2 g-col-6">Grid item 1</div>
+  <div class="p-2 g-col-6">Grid item 2</div>
+  <div class="p-2 g-col-6">Grid item 3</div>
+  <div class="p-2 g-col-6">Grid item 4</div>
+</div>
+ +

column-gap

+

column-gap sets the horizontal space between children items in the specified container.

+
+
+
Grid item 1
+
Grid item 2
+
Grid item 3
+
Grid item 4
+
+
+ html +
+ + +
+ 
<div class="grid gap-0 column-gap-3">
+  <div class="p-2 g-col-6">Grid item 1</div>
+  <div class="p-2 g-col-6">Grid item 2</div>
+  <div class="p-2 g-col-6">Grid item 3</div>
+  <div class="p-2 g-col-6">Grid item 4</div>
+</div>
+ +

Sass

+

Maps

+

Spacing utilities are declared via Sass map and then generated with our utilities API.

+
$spacer: 1rem;
+$spacers: (
+  0: 0,
+  1: $spacer * .25,
+  2: $spacer * .5,
+  3: $spacer,
+  4: $spacer * 1.5,
+  5: $spacer * 3,
+);
+
+

Utilities API

+

Spacing utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "margin": (
+      responsive: true,
+      property: margin,
+      class: m,
+      values: map-merge($spacers, (auto: auto))
+    ),
+    "margin-x": (
+      responsive: true,
+      property: margin-right margin-left,
+      class: mx,
+      values: map-merge($spacers, (auto: auto))
+    ),
+    "margin-y": (
+      responsive: true,
+      property: margin-top margin-bottom,
+      class: my,
+      values: map-merge($spacers, (auto: auto))
+    ),
+    "margin-top": (
+      responsive: true,
+      property: margin-top,
+      class: mt,
+      values: map-merge($spacers, (auto: auto))
+    ),
+    "margin-end": (
+      responsive: true,
+      property: margin-right,
+      class: me,
+      values: map-merge($spacers, (auto: auto))
+    ),
+    "margin-bottom": (
+      responsive: true,
+      property: margin-bottom,
+      class: mb,
+      values: map-merge($spacers, (auto: auto))
+    ),
+    "margin-start": (
+      responsive: true,
+      property: margin-left,
+      class: ms,
+      values: map-merge($spacers, (auto: auto))
+    ),
+    // Negative margin utilities
+    "negative-margin": (
+      responsive: true,
+      property: margin,
+      class: m,
+      values: $negative-spacers
+    ),
+    "negative-margin-x": (
+      responsive: true,
+      property: margin-right margin-left,
+      class: mx,
+      values: $negative-spacers
+    ),
+    "negative-margin-y": (
+      responsive: true,
+      property: margin-top margin-bottom,
+      class: my,
+      values: $negative-spacers
+    ),
+    "negative-margin-top": (
+      responsive: true,
+      property: margin-top,
+      class: mt,
+      values: $negative-spacers
+    ),
+    "negative-margin-end": (
+      responsive: true,
+      property: margin-right,
+      class: me,
+      values: $negative-spacers
+    ),
+    "negative-margin-bottom": (
+      responsive: true,
+      property: margin-bottom,
+      class: mb,
+      values: $negative-spacers
+    ),
+    "negative-margin-start": (
+      responsive: true,
+      property: margin-left,
+      class: ms,
+      values: $negative-spacers
+    ),
+    // Padding utilities
+    "padding": (
+      responsive: true,
+      property: padding,
+      class: p,
+      values: $spacers
+    ),
+    "padding-x": (
+      responsive: true,
+      property: padding-right padding-left,
+      class: px,
+      values: $spacers
+    ),
+    "padding-y": (
+      responsive: true,
+      property: padding-top padding-bottom,
+      class: py,
+      values: $spacers
+    ),
+    "padding-top": (
+      responsive: true,
+      property: padding-top,
+      class: pt,
+      values: $spacers
+    ),
+    "padding-end": (
+      responsive: true,
+      property: padding-right,
+      class: pe,
+      values: $spacers
+    ),
+    "padding-bottom": (
+      responsive: true,
+      property: padding-bottom,
+      class: pb,
+      values: $spacers
+    ),
+    "padding-start": (
+      responsive: true,
+      property: padding-left,
+      class: ps,
+      values: $spacers
+    ),
+    // Gap utility
+    "gap": (
+      responsive: true,
+      property: gap,
+      class: gap,
+      values: $spacers
+    ),
+    "row-gap": (
+      responsive: true,
+      property: row-gap,
+      class: row-gap,
+      values: $spacers
+    ),
+    "column-gap": (
+      responsive: true,
+      property: column-gap,
+      class: column-gap,
+      values: $spacers
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/text/index.html b/docs/5.3/utilities/text/index.html new file mode 100644 index 0000000000..5379cf37c4 --- /dev/null +++ b/docs/5.3/utilities/text/index.html @@ -0,0 +1,1078 @@ + + + + + + + + + + + + +Text · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Text

+
+

Documentation and examples for common text utilities to control alignment, wrapping, weight, and more.

+ + +
+ + +
+ + On this page +
+ +
+ + +
+ + +

Text alignment

+

Easily realign text to components with text alignment classes. For start, end, and center alignment, responsive classes are available that use the same viewport width breakpoints as the grid system.

+
+

Start aligned text on all viewport sizes.

+

Center aligned text on all viewport sizes.

+

End aligned text on all viewport sizes.

+ +

Start aligned text on viewports sized SM (small) or wider.

+

Start aligned text on viewports sized MD (medium) or wider.

+

Start aligned text on viewports sized LG (large) or wider.

+

Start aligned text on viewports sized XL (extra-large) or wider.

+
+ html +
+ + +
+ 
<p class="text-start">Start aligned text on all viewport sizes.</p>
+<p class="text-center">Center aligned text on all viewport sizes.</p>
+<p class="text-end">End aligned text on all viewport sizes.</p>
+
+<p class="text-sm-start">Start aligned text on viewports sized SM (small) or wider.</p>
+<p class="text-md-start">Start aligned text on viewports sized MD (medium) or wider.</p>
+<p class="text-lg-start">Start aligned text on viewports sized LG (large) or wider.</p>
+<p class="text-xl-start">Start aligned text on viewports sized XL (extra-large) or wider.</p>
+ +
+Note that we don’t provide utility classes for justified text. While, aesthetically, justified text might look more appealing, it does make word-spacing more random and therefore harder to read. +
+ +

Text wrapping and overflow

+

Wrap text with a .text-wrap class.

+
+
+ This text should wrap. +
+
+ html +
+ + +
+ 
<div class="badge bg-primary text-wrap" style="width: 6rem;">
+  This text should wrap.
+</div>
+ +

Prevent text from wrapping with a .text-nowrap class.

+
+
+ This text should overflow the parent. +
+
+ html +
+ + +
+ 
<div class="text-nowrap bg-body-secondary border" style="width: 8rem;">
+  This text should overflow the parent.
+</div>
+ +

Word break

+

Prevent long strings of text from breaking your components’ layout by using .text-break to set word-wrap: break-word and word-break: break-word. We use word-wrap instead of the more common overflow-wrap for wider browser support, and add the deprecated word-break: break-word to avoid issues with flex containers.

+
+

mmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmm

+
+ html +
+ + +
+ 
<p class="text-break">mmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmm</p>
+ +
+Note that breaking words isn’t possible in Arabic, which is the most used RTL language. Therefore .text-break is removed from our RTL compiled CSS. +
+ +

Text transform

+

Transform text in components with text capitalization classes.

+
+

Lowercased text.

+

Uppercased text.

+

CapiTaliZed text.

+
+ html +
+ + +
+ 
<p class="text-lowercase">Lowercased text.</p>
+<p class="text-uppercase">Uppercased text.</p>
+<p class="text-capitalize">CapiTaliZed text.</p>
+ +

Note how .text-capitalize only changes the first letter of each word, leaving the case of any other letters unaffected.

+

Font size

+

Quickly change the font-size of text. While our heading classes (e.g., .h1–.h6) apply font-size, font-weight, and line-height, these utilities only apply font-size. Sizing for these utilities matches HTML’s heading elements, so as the number increases, their size decreases.

+
+

.fs-1 text

+

.fs-2 text

+

.fs-3 text

+

.fs-4 text

+

.fs-5 text

+

.fs-6 text

+
+ html +
+ + +
+ 
<p class="fs-1">.fs-1 text</p>
+<p class="fs-2">.fs-2 text</p>
+<p class="fs-3">.fs-3 text</p>
+<p class="fs-4">.fs-4 text</p>
+<p class="fs-5">.fs-5 text</p>
+<p class="fs-6">.fs-6 text</p>
+ +

Customize your available font-sizes by modifying the $font-sizes Sass map.

+

Font weight and italics

+

Quickly change the font-weight or font-style of text with these utilities. font-style utilities are abbreviated as .fst-* and font-weight utilities are abbreviated as .fw-*.

+
+

Bold text.

+

Bolder weight text (relative to the parent element).

+

Semibold weight text.

+

Normal weight text.

+

Light weight text.

+

Lighter weight text (relative to the parent element).

+

Italic text.

+

Text with normal font style

+
+ html +
+ + +
+ 
<p class="fw-bold">Bold text.</p>
+<p class="fw-bolder">Bolder weight text (relative to the parent element).</p>
+<p class="fw-semibold">Semibold weight text.</p>
+<p class="fw-normal">Normal weight text.</p>
+<p class="fw-light">Light weight text.</p>
+<p class="fw-lighter">Lighter weight text (relative to the parent element).</p>
+<p class="fst-italic">Italic text.</p>
+<p class="fst-normal">Text with normal font style</p>
+ +

Line height

+

Change the line height with .lh-* utilities.

+
+

This is a long paragraph written to show how the line-height of an element is affected by our utilities. Classes are applied to the element itself or sometimes the parent element. These classes can be customized as needed with our utility API.

+

This is a long paragraph written to show how the line-height of an element is affected by our utilities. Classes are applied to the element itself or sometimes the parent element. These classes can be customized as needed with our utility API.

+

This is a long paragraph written to show how the line-height of an element is affected by our utilities. Classes are applied to the element itself or sometimes the parent element. These classes can be customized as needed with our utility API.

+

This is a long paragraph written to show how the line-height of an element is affected by our utilities. Classes are applied to the element itself or sometimes the parent element. These classes can be customized as needed with our utility API.

+
+ html +
+ + +
+ 
<p class="lh-1">This is a long paragraph written to show how the line-height of an element is affected by our utilities. Classes are applied to the element itself or sometimes the parent element. These classes can be customized as needed with our utility API.</p>
+<p class="lh-sm">This is a long paragraph written to show how the line-height of an element is affected by our utilities. Classes are applied to the element itself or sometimes the parent element. These classes can be customized as needed with our utility API.</p>
+<p class="lh-base">This is a long paragraph written to show how the line-height of an element is affected by our utilities. Classes are applied to the element itself or sometimes the parent element. These classes can be customized as needed with our utility API.</p>
+<p class="lh-lg">This is a long paragraph written to show how the line-height of an element is affected by our utilities. Classes are applied to the element itself or sometimes the parent element. These classes can be customized as needed with our utility API.</p>
+ +

Monospace

+

Change a selection to our monospace font stack with .font-monospace.

+
+

This is in monospace

+
+ html +
+ + +
+ 
<p class="font-monospace">This is in monospace</p>
+ +

Reset color

+

Reset a text or link’s color with .text-reset, so that it inherits the color from its parent.

+
+

+ Muted text with a reset link. +

+
+ html +
+ + +
+ 
<p class="text-muted">
+  Muted text with a <a href="#" class="text-reset">reset link</a>.
+</p>
+ +

Text decoration

+

Decorate text in components with text decoration classes.

+
+

This text has a line underneath it.

+

This text has a line going through it.

+This link has its text decoration removed +
+ html +
+ + +
+ 
<p class="text-decoration-underline">This text has a line underneath it.</p>
+<p class="text-decoration-line-through">This text has a line going through it.</p>
+<a href="#" class="text-decoration-none">This link has its text decoration removed</a>
+ +

Sass

+

Variables

+
// stylelint-disable value-keyword-case
+$font-family-sans-serif:      system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", "Noto Sans", "Liberation Sans", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
+$font-family-monospace:       SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
+// stylelint-enable value-keyword-case
+$font-family-base:            var(--#{$prefix}font-sans-serif);
+$font-family-code:            var(--#{$prefix}font-monospace);
+
+// $font-size-root affects the value of `rem`, which is used for as well font sizes, paddings, and margins
+// $font-size-base affects the font size of the body text
+$font-size-root:              null;
+$font-size-base:              1rem; // Assumes the browser default, typically `16px`
+$font-size-sm:                $font-size-base * .875;
+$font-size-lg:                $font-size-base * 1.25;
+
+$font-weight-lighter:         lighter;
+$font-weight-light:           300;
+$font-weight-normal:          400;
+$font-weight-medium:          500;
+$font-weight-semibold:        600;
+$font-weight-bold:            700;
+$font-weight-bolder:          bolder;
+
+$font-weight-base:            $font-weight-normal;
+
+$line-height-base:            1.5;
+$line-height-sm:              1.25;
+$line-height-lg:              2;
+
+$h1-font-size:                $font-size-base * 2.5;
+$h2-font-size:                $font-size-base * 2;
+$h3-font-size:                $font-size-base * 1.75;
+$h4-font-size:                $font-size-base * 1.5;
+$h5-font-size:                $font-size-base * 1.25;
+$h6-font-size:                $font-size-base;
+
+

Maps

+

Font-size utilities are generated from this map, in combination with our utilities API.

+
$font-sizes: (
+  1: $h1-font-size,
+  2: $h2-font-size,
+  3: $h3-font-size,
+  4: $h4-font-size,
+  5: $h5-font-size,
+  6: $h6-font-size
+);
+
+

Utilities API

+

Font and text utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "font-family": (
+      property: font-family,
+      class: font,
+      values: (monospace: var(--#{$prefix}font-monospace))
+    ),
+    "font-size": (
+      rfs: true,
+      property: font-size,
+      class: fs,
+      values: $font-sizes
+    ),
+    "font-style": (
+      property: font-style,
+      class: fst,
+      values: italic normal
+    ),
+    "font-weight": (
+      property: font-weight,
+      class: fw,
+      values: (
+        lighter: $font-weight-lighter,
+        light: $font-weight-light,
+        normal: $font-weight-normal,
+        medium: $font-weight-medium,
+        semibold: $font-weight-semibold,
+        bold: $font-weight-bold,
+        bolder: $font-weight-bolder
+      )
+    ),
+    "line-height": (
+      property: line-height,
+      class: lh,
+      values: (
+        1: 1,
+        sm: $line-height-sm,
+        base: $line-height-base,
+        lg: $line-height-lg,
+      )
+    ),
+    "text-align": (
+      responsive: true,
+      property: text-align,
+      class: text,
+      values: (
+        start: left,
+        end: right,
+        center: center,
+      )
+    ),
+    "text-decoration": (
+      property: text-decoration,
+      values: none underline line-through
+    ),
+    "text-transform": (
+      property: text-transform,
+      class: text,
+      values: lowercase uppercase capitalize
+    ),
+    "white-space": (
+      property: white-space,
+      class: text,
+      values: (
+        wrap: normal,
+        nowrap: nowrap,
+      )
+    ),
+    "word-wrap": (
+      property: word-wrap word-break,
+      class: text,
+      values: (break: break-word),
+      rtl: false
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/vertical-align/index.html b/docs/5.3/utilities/vertical-align/index.html new file mode 100644 index 0000000000..736cb17d2e --- /dev/null +++ b/docs/5.3/utilities/vertical-align/index.html @@ -0,0 +1,748 @@ + + + + + + + + + + + + +Vertical alignment · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Vertical alignment

+
+

Easily change the vertical alignment of inline, inline-block, inline-table, and table cell elements.

+ + +
+ + + +
+ + +

Change the alignment of elements with the vertical-alignment utilities. Please note that vertical-align only affects inline, inline-block, inline-table, and table cell elements.

+

Choose from .align-baseline, .align-top, .align-middle, .align-bottom, .align-text-bottom, and .align-text-top as needed.

+

To vertically center non-inline content (like <div>s and more), use our flex box utilities.

+

With inline elements:

+
+baseline +top +middle +bottom +text-top +text-bottom +
+ html +
+ + +
+ 
<span class="align-baseline">baseline</span>
+<span class="align-top">top</span>
+<span class="align-middle">middle</span>
+<span class="align-bottom">bottom</span>
+<span class="align-text-top">text-top</span>
+<span class="align-text-bottom">text-bottom</span>
+ +

With table cells:

+
+ + + + + + + + + + + +
baselinetopmiddlebottomtext-toptext-bottom
+
+ html +
+ + +
+ 
<table style="height: 100px;">
+  <tbody>
+    <tr>
+      <td class="align-baseline">baseline</td>
+      <td class="align-top">top</td>
+      <td class="align-middle">middle</td>
+      <td class="align-bottom">bottom</td>
+      <td class="align-text-top">text-top</td>
+      <td class="align-text-bottom">text-bottom</td>
+    </tr>
+  </tbody>
+</table>
+ +

Sass

+

Utilities API

+

Vertical align utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "align": (
+      property: vertical-align,
+      class: align,
+      values: baseline top middle bottom text-bottom text-top
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/visibility/index.html b/docs/5.3/utilities/visibility/index.html new file mode 100644 index 0000000000..489b4cb2cf --- /dev/null +++ b/docs/5.3/utilities/visibility/index.html @@ -0,0 +1,701 @@ + + + + + + + + + + + + +Visibility · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
+ View on GitHub + +
+

Visibility

+
+

Control the visibility of elements, without modifying their display, with visibility utilities.

+ + +
+ + + +
+ + +

Set the visibility of elements with our visibility utilities. These utility classes do not modify the display value at all and do not affect layout – .invisible elements still take up space in the page.

+
+Elements with the .invisible class will be hidden both visually and for assistive technology/screen reader users. +
+ +

Apply .visible or .invisible as needed.

+
<div class="visible">...</div>
+<div class="invisible">...</div>
+
// Class
+.visible {
+  visibility: visible !important;
+}
+.invisible {
+  visibility: hidden !important;
+}
+

Sass

+

Utilities API

+

Visibility utilities are declared in our utilities API in scss/_utilities.scss. Learn how to use the utilities API.

+
    "visibility": (
+      property: visibility,
+      class: null,
+      values: (
+        visible: visible,
+        invisible: hidden,
+      )
+    ),
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/5.3/utilities/z-index/index.html b/docs/5.3/utilities/z-index/index.html new file mode 100644 index 0000000000..5e9822d387 --- /dev/null +++ b/docs/5.3/utilities/z-index/index.html @@ -0,0 +1,742 @@ + + + + + + + + + + + + +Z-index · Bootstrap v5.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ Skip to main content + Skip to docs navigation +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + +
+
+
+
Added in v5.3 + View on GitHub + +
+

Z-index

+
+

Use our low-level z-index utilities to quickly change the stack level of an element or component.

+ + +
+ + +
+ + On this page +
+
+ +
+
+ + +
+ + +

Example

+

Use z-index utilities to stack elements on top of one another. Requires a position value other than static, which can be set with custom styles or using our position utilities.

+
+We call these “low-level” z-index utilities because of their default values of -1 through 3, which we use for the layout of overlapping components. High-level z-index values are used for overlay components like modals and tooltips. +
+ +
+
+
+
+
+
+
+ html +
+ + +
+ 
<div class="z-3 position-absolute p-5 rounded-3"></div>
+<div class="z-2 position-absolute p-5 rounded-3"></div>
+<div class="z-1 position-absolute p-5 rounded-3"></div>
+<div class="z-0 position-absolute p-5 rounded-3"></div>
+<div class="z-n1 position-absolute p-5 rounded-3"></div>
+ +

Overlays

+

Bootstrap overlay components—dropdown, modal, offcanvas, popover, toast, and tooltip—all have their own z-index values to ensure a usable experience with competing “layers” of an interface.

+

Read about them in the z-index layout page.

+

Component approach

+

On some components, we use our low-level z-index values to manage repeating elements that overlap one another (like buttons in a button group or items in a list group).

+

Learn about our z-index approach.

+

CSS

+

Sass map

+

Customize this Sass map to change the available values and generated utilities.

+
$zindex-levels: (
+  n1: -1,
+  0: 0,
+  1: 1,
+  2: 2,
+  3: 3
+);
+
+ +
+
+
+ + + + + + + + + + + + + + + + +
+ + + diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html index 212c1e0631..349df656a8 100644 --- a/docs/getting-started/index.html +++ b/docs/getting-started/index.html @@ -3,10 +3,10 @@ - https://getbootstrap.com/docs/5.2/getting-started/introduction/ - + https://getbootstrap.com/docs/5.3/getting-started/introduction/ + - + diff --git a/docs/index.html b/docs/index.html index 212c1e0631..349df656a8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,10 +3,10 @@ - https://getbootstrap.com/docs/5.2/getting-started/introduction/ - + https://getbootstrap.com/docs/5.3/getting-started/introduction/ + - + diff --git a/docs/versions/index.html b/docs/versions/index.html index c8a12beb2a..e02f96b1dd 100644 --- a/docs/versions/index.html +++ b/docs/versions/index.html @@ -1,34 +1,34 @@ - + - + - + -Versions · Bootstrap v5.2 +Versions · Bootstrap v5.3 + + - - - + - - - - - - + + + + + + @@ -36,7 +36,7 @@ - + @@ -45,7 +45,7 @@ - + @@ -84,12 +84,14 @@ - Check + + + @@ -119,6 +121,10 @@ + + + + @@ -129,6 +135,9 @@ + + + @@ -141,7 +150,7 @@ -
+