diff options
Diffstat (limited to 'vendor/twbs/bootstrap/site/content/docs/5.3/utilities/borders.md')
-rw-r--r-- | vendor/twbs/bootstrap/site/content/docs/5.3/utilities/borders.md | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/vendor/twbs/bootstrap/site/content/docs/5.3/utilities/borders.md b/vendor/twbs/bootstrap/site/content/docs/5.3/utilities/borders.md new file mode 100644 index 000000000..50df793f2 --- /dev/null +++ b/vendor/twbs/bootstrap/site/content/docs/5.3/utilities/borders.md @@ -0,0 +1,175 @@ +--- +layout: docs +title: Borders +description: Use border utilities to quickly style the border and border-radius of an element. Great for images, buttons, or any other element. +group: utilities +toc: true +--- + +## 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: + +{{< example class="bd-example-border-utils" >}} +<span class="border"></span> +<span class="border-top"></span> +<span class="border-end"></span> +<span class="border-bottom"></span> +<span class="border-start"></span> +{{< /example >}} + +### Subtractive + +Or remove borders: + +{{< example class="bd-example-border-utils" >}} +<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> +{{< /example >}} + +## Color + +Change the border color using utilities built on our theme colors. + +{{< example class="bd-example-border-utils" >}} +{{< border.inline >}} +{{- range (index $.Site.Data "theme-colors") }} +<span class="border border-{{ .name }}"></span> +<span class="border border-{{ .name }}-subtle"></span> +{{- end -}} +{{< /border.inline >}} +<span class="border border-white"></span> +{{< /example >}} + +Or modify the default `border-color` of a component: + +{{< example >}} +<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> +{{< /example >}} + +## Opacity + +{{< added-in "5.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. + +```css +.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. + +{{< example >}} +<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> +{{< /example >}} + +Or, choose from any of the `.border-opacity` utilities: + +{{< example >}} +<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> +{{< /example >}} + +## Width + +{{< example class="bd-example-border-utils" >}} +<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> +{{< /example >}} + +## Radius + +Add classes to an element to easily round its corners. + +{{< example class="bd-example-rounded-utils" >}} +{{< placeholder width="75" height="75" class="rounded" title="Example rounded image" >}} +{{< placeholder width="75" height="75" class="rounded-top" title="Example top rounded image" >}} +{{< placeholder width="75" height="75" class="rounded-end" title="Example right rounded image" >}} +{{< placeholder width="75" height="75" class="rounded-bottom" title="Example bottom rounded image" >}} +{{< placeholder width="75" height="75" class="rounded-start" title="Example left rounded image" >}} +{{< placeholder width="75" height="75" class="rounded-circle" title="Completely round image" >}} +{{< placeholder width="150" height="75" class="rounded-pill" title="Rounded pill image" >}} +{{< /example >}} + +### 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 class="bd-example-rounded-utils" >}} +{{< placeholder width="75" height="75" class="rounded-0" title="Example non-rounded image" >}} +{{< placeholder width="75" height="75" class="rounded-1" title="Example small rounded image" >}} +{{< placeholder width="75" height="75" class="rounded-2" title="Example default rounded image" >}} +{{< placeholder width="75" height="75" class="rounded-3" title="Example large rounded image" >}} +{{< placeholder width="75" height="75" class="rounded-4" title="Example larger rounded image" >}} +{{< placeholder width="75" height="75" class="rounded-5" title="Example extra large rounded image" >}} +{{< /example >}} + +{{< example class="bd-example-rounded-utils" >}} +{{< placeholder width="75" height="75" class="rounded-bottom-1" title="Example small rounded image" >}} +{{< placeholder width="75" height="75" class="rounded-start-2" title="Example default left rounded image" >}} +{{< placeholder width="75" height="75" class="rounded-end-circle" title="Example right completely round image" >}} +{{< placeholder width="75" height="75" class="rounded-start-pill" title="Example left rounded pill image" >}} +{{< placeholder width="75" height="75" class="rounded-5 rounded-top-0" title="Example extra large bottom rounded image" >}} +{{< /example >}} + +## CSS + +### Variables + +{{< added-in "5.2.0" >}} + +{{< scss-docs name="root-border-var" file="scss/_root.scss" >}} + +### Sass variables + +{{< scss-docs name="border-variables" file="scss/_variables.scss" >}} + +{{< scss-docs name="border-radius-variables" file="scss/_variables.scss" >}} + +### Sass mixins + +{{< scss-docs name="border-radius-mixins" file="scss/mixins/_border-radius.scss" >}} + +### Utilities API + +Border utilities are declared in our utilities API in `scss/_utilities.scss`. [Learn how to use the utilities API.]({{< docsref "/utilities/api#using-the-api" >}}) + +{{< scss-docs name="utils-borders" file="scss/_utilities.scss" >}} + +{{< scss-docs name="utils-border-radius" file="scss/_utilities.scss" >}} |