From 3ea39841c8049525e31e9f4d6300f0c60cdb42de Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Tue, 24 Jan 2023 13:33:51 +0100 Subject: Adding upstream version 5.2.3+dfsg. Signed-off-by: Daniel Baumann --- .../docs/5.2/getting-started/accessibility.md | 62 ++++ .../docs/5.2/getting-started/best-practices.md | 20 ++ .../docs/5.2/getting-started/browsers-devices.md | 79 +++++ site/content/docs/5.2/getting-started/contents.md | 111 +++++++ .../content/docs/5.2/getting-started/contribute.md | 67 ++++ site/content/docs/5.2/getting-started/download.md | 119 ++++++++ .../docs/5.2/getting-started/introduction.md | 162 ++++++++++ .../content/docs/5.2/getting-started/javascript.md | 337 +++++++++++++++++++++ site/content/docs/5.2/getting-started/parcel.md | 159 ++++++++++ site/content/docs/5.2/getting-started/rfs.md | 86 ++++++ site/content/docs/5.2/getting-started/rtl.md | 182 +++++++++++ site/content/docs/5.2/getting-started/vite.md | 198 ++++++++++++ site/content/docs/5.2/getting-started/webpack.md | 322 ++++++++++++++++++++ 13 files changed, 1904 insertions(+) create mode 100644 site/content/docs/5.2/getting-started/accessibility.md create mode 100644 site/content/docs/5.2/getting-started/best-practices.md create mode 100644 site/content/docs/5.2/getting-started/browsers-devices.md create mode 100644 site/content/docs/5.2/getting-started/contents.md create mode 100644 site/content/docs/5.2/getting-started/contribute.md create mode 100644 site/content/docs/5.2/getting-started/download.md create mode 100644 site/content/docs/5.2/getting-started/introduction.md create mode 100644 site/content/docs/5.2/getting-started/javascript.md create mode 100644 site/content/docs/5.2/getting-started/parcel.md create mode 100644 site/content/docs/5.2/getting-started/rfs.md create mode 100644 site/content/docs/5.2/getting-started/rtl.md create mode 100644 site/content/docs/5.2/getting-started/vite.md create mode 100644 site/content/docs/5.2/getting-started/webpack.md (limited to 'site/content/docs/5.2/getting-started') diff --git a/site/content/docs/5.2/getting-started/accessibility.md b/site/content/docs/5.2/getting-started/accessibility.md new file mode 100644 index 0000000..e9f1cb3 --- /dev/null +++ b/site/content/docs/5.2/getting-started/accessibility.md @@ -0,0 +1,62 @@ +--- +layout: docs +title: Accessibility +description: A brief overview of Bootstrap's features and limitations for the creation of accessible content. +group: getting-started +toc: true +--- + +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](https://www.w3.org/TR/WCAG/) (A/AA/AAA), [Section 508](https://www.section508.gov/), 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](https://www.w3.org/WAI/standards-guidelines/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](https://www.w3.org/TR/WCAG/#contrast-minimum) and the [WCAG 2.1 non-text color contrast ratio of 3:1](https://www.w3.org/TR/WCAG/#non-text-contrast)), 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. + +```html +

+ Danger: + This action is not reversible +

+``` + +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.** + +```html +Skip to main content +``` + +### Reduced motion + +Bootstrap includes support for the [`prefers-reduced-motion` media feature](https://www.w3.org/TR/mediaqueries-5/#prefers-reduced-motion). 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 + +- [Web Content Accessibility Guidelines (WCAG) 2.1](https://www.w3.org/TR/WCAG/) +- [The A11Y Project](https://www.a11yproject.com/) +- [MDN accessibility documentation](https://developer.mozilla.org/en-US/docs/Web/Accessibility) +- [Tenon.io Accessibility Checker](https://tenon.io/) +- [Color Contrast Analyser (CCA)](https://www.tpgi.com/color-contrast-checker/) +- ["HTML Codesniffer" bookmarklet for identifying accessibility issues](https://github.com/squizlabs/HTML_CodeSniffer) +- [Microsoft Accessibility Insights](https://accessibilityinsights.io/) +- [Deque Axe testing tools](https://www.deque.com/axe/) +- [Introduction to Web Accessibility](https://www.w3.org/WAI/fundamentals/accessibility-intro/) diff --git a/site/content/docs/5.2/getting-started/best-practices.md b/site/content/docs/5.2/getting-started/best-practices.md new file mode 100644 index 0000000..449d02a --- /dev/null +++ b/site/content/docs/5.2/getting-started/best-practices.md @@ -0,0 +1,20 @@ +--- +layout: docs +title: Best practices +description: Learn about some of the best practices we've gathered from years of working on and using Bootstrap. +group: getting-started +--- + +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. + +{{< callout info >}} +**Heads up!** This copy is a work in progress. +{{< /callout >}} + +### General outline + +- Working with CSS +- Working with Sass files +- Building new CSS components +- Working with flexbox +- Ask in [our GitHub Discussions](https://github.com/twbs/bootstrap/discussions) diff --git a/site/content/docs/5.2/getting-started/browsers-devices.md b/site/content/docs/5.2/getting-started/browsers-devices.md new file mode 100644 index 0000000..dc550ec --- /dev/null +++ b/site/content/docs/5.2/getting-started/browsers-devices.md @@ -0,0 +1,79 @@ +--- +layout: docs +title: Browsers and devices +description: Learn about the browsers and devices, from modern to old, that are supported by Bootstrap, including known quirks and bugs for each. +group: getting-started +toc: true +--- + +## 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`]({{< param repo >}}/blob/v{{< param current_version >}}/.browserslistrc): + +```text +{{< rf.inline >}} +{{- readFile ".browserslistrc" | chomp | htmlEscape -}} +{{< /rf.inline >}} +``` + +We use [Autoprefixer](https://github.com/postcss/autoprefixer) to handle intended browser support via CSS prefixes, which uses [Browserslist](https://github.com/browserslist/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. + +{{< bs-table "table" >}} +| | Chrome | Firefox | Safari | Android Browser & WebView | +| --- | --- | --- | --- | --- | +| **Android** | Supported | Supported | | v6.0+ | +| **iOS** | Supported | Supported | Supported | | +{{< /bs-table >}} + +### Desktop browsers + +Similarly, the latest versions of most desktop browsers are supported. + +{{< bs-table "table" >}} +| | Chrome | Firefox | Microsoft Edge | Opera | Safari | +| --- | --- | --- | --- | --- | --- | +| **Mac** | Supported | Supported | Supported | Supported | Supported | +| **Windows** | Supported | Supported | Supported | Supported | | +{{< /bs-table >}} + +For Firefox, in addition to the latest normal stable release, we also support the latest [Extended Support Release (ESR)](https://www.mozilla.org/en-US/firefox/enterprise/) 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 `` 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 `` content will begin to scroll. See [Chrome bug #175502](https://bugs.chromium.org/p/chromium/issues/detail?id=175502) (fixed in Chrome v40) and [WebKit bug #153852](https://bugs.webkit.org/show_bug.cgi?id=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 `` or a `