GNOME JS

https://gjs-docs.gnome.org
Admin
GNOME JS provides API documentation for writing GNOME applications using JavaScript.
Tokens:974,467
Snippets:11,900
Trust Score:10
Update:5 days ago
Show doc for...
Tokens:
Raw
### Writing mode examples

Source: https://gjs-docs.gnome.org/css/ident

Examples demonstrating different writing-mode configurations.

```css
writing-mode: horizontal-tb;
```

```css
writing-mode: vertical-rl;
```

```css
writing-mode: horizontal-tb;
direction: rtl;
```

```css
writing-mode: vertical-lr;
```

--------------------------------

### Syntax examples

Source: https://gjs-docs.gnome.org/css/rx

Examples of length and global values for scroll-margin-inline-end.

```css
/* <length> values */
scroll-margin-inline-end: 10px;
scroll-margin-inline-end: 1em;

/* Global values */
scroll-margin-inline-end: inherit;
scroll-margin-inline-end: initial;
scroll-margin-inline-end: revert;
scroll-margin-inline-end: revert-layer;
scroll-margin-inline-end: unset;
```

--------------------------------

### Example container structure

Source: https://gjs-docs.gnome.org/css/outline-width

HTML and CSS setup for demonstrating text wrapping behavior in a constrained container.

```html
<section class="default-example" id="default-example">
  <div class="example-container">
    Most words are short &amp; don't need to break. But
    <strong class="transition-all" id="example-element"
      >Antidisestablishmentarianism</strong
    >
    is long. The width is set to min-content, with a max-width of 11em.
  </div>
</section>
```

```css
.example-container {
  background-color: rgb(255 0 200 / 0.2);
  border: 3px solid rebeccapurple;
  padding: 0.75em;
  width: min-content;
  max-width: 11em;
  height: 200px;
}
```

--------------------------------

### Setting block start offset example

Source: https://gjs-docs.gnome.org/css/ident

HTML and CSS for setting a block start offset.

```html
<div>
  <p class="exampleText">Example text</p>
</div>
```

```css
div {
  background-color: yellow;
  width: 120px;
  height: 120px;
}

.exampleText {
  writing-mode: vertical-lr;
  position: relative;
  inset-block-start: 20px;
  background-color: #c8c800;
}
```

--------------------------------

### border-block-start usage examples

Source: https://gjs-docs.gnome.org/css/basic-shape/path

Examples showing various border-block-start configurations with different writing modes.

```css
border-block-start: solid;
writing-mode: horizontal-tb;
```

```css
border-block-start: dashed red;
writing-mode: vertical-rl;
```

```css
border-block-start: 1rem solid;
writing-mode: horizontal-tb;
```

```css
border-block-start: thick double #32a1ce;
writing-mode: vertical-lr;
```

--------------------------------

### Setting inline start and end margins

Source: https://gjs-docs.gnome.org/css/line-style

Example demonstrating how to set inline start and end margins using CSS and HTML.

```css
div {
  background-color: yellow;
  width: 120px;
  height: auto;
  border: 1px solid green;
}

p {
  margin: 0;
  margin-inline: 20px 40px;
  background-color: tan;
}

.verticalExample {
  writing-mode: vertical-rl;
}
```

```html
<div>
  <p>Example text</p>
</div>
<div class="verticalExample">
  <p>Example text</p>
</div>
```

--------------------------------

### padding-top length and percentage examples

Source: https://gjs-docs.gnome.org/css/padding-block

Examples of setting padding-top using various units.

```css
padding-top: 1em;
```

```css
padding-top: 10%;
```

```css
padding-top: 20px;
```

```css
padding-top: 1ch;
```

```css
padding-top: 0;
```

--------------------------------

### Example CSS styling

Source: https://gjs-docs.gnome.org/css/unicode-bidi

CSS styles for the example container and elements.

```css
.example-container {
  border: 1px solid #c5c5c5;
  padding: 0.75em;
  width: 80%;
  max-height: 300px;
  display: flex;
}

.example-container > div {
  background-color: rgb(0 0 255 / 0.2);
  border: 3px solid blue;
  margin: 10px;
  flex: 1;
}

#example-element {
  background-color: rgb(255 0 200 / 0.2);
  border: 3px solid rebeccapurple;
}
```

--------------------------------

### HTML structure for transition example

Source: https://gjs-docs.gnome.org/css/transform-function/translate

The HTML structure for the default transition example.

```html
<section id="default-example">
  <div id="example-element">Hover to see<br />the transition.</div>
</section>
```

--------------------------------

### Try it: Bitwise AND example

Source: https://gjs-docs.gnome.org/javascript/iteration_protocols

Interactive example showing bitwise AND of 5 and 3, with expected output 1.

```javascript
const a = 5; // 00000000000000000000000000000101
const b = 3; // 00000000000000000000000000000011

console.log(a & b); // 00000000000000000000000000000001
// Expected output: 1
```

--------------------------------

### Using indexOf() Examples

Source: https://gjs-docs.gnome.org/javascript/global_objects/typedarray/findindex

Additional examples showing how indexOf() behaves with various search elements and starting indices, including negative fromIndex values.

```javascript
const uint8 = new Uint8Array([2, 5, 9]);
uint8.indexOf(2); // 0
uint8.indexOf(7); // -1
uint8.indexOf(9, 2); // 2
uint8.indexOf(2, -1); // -1
uint8.indexOf(2, -3); // 0
```

--------------------------------

### cx Syntax Examples

Source: https://gjs-docs.gnome.org/css/css_display/block_formatting_context

Examples of valid length, percentage, and global values for the cx property.

```css
/* length and percentage values */
cx: 20px;
cx: 20%;

/* Global values */
cx: inherit;
cx: initial;
cx: revert;
cx: revert-layer;
cx: unset;
```

--------------------------------

### Try it: CSS for column-rule-style example

Source: https://gjs-docs.gnome.org/css/color_value/hwb

CSS for the interactive example that sets three columns and a solid column rule.

```css
#example-element {
  columns: 3;
  column-rule: solid;
  text-align: left;
}

```

--------------------------------

### Defaulting Process Examples

Source: https://gjs-docs.gnome.org/css/cos

Examples showing how inherited and non-inherited properties behave during the defaulting process.

```css
color: inherit;
margin: 0;
```

--------------------------------

### transition-delay syntax examples

Source: https://gjs-docs.gnome.org/css/transform-function/translate

Examples of time values and global values for the transition-delay property.

```css
/* <time> values */
transition-delay: 3s;
transition-delay: 2s, 4ms;

/* Global values */
transition-delay: inherit;
transition-delay: initial;
transition-delay: revert;
transition-delay: revert-layer;
transition-delay: unset;
```

--------------------------------

### Default example HTML

Source: https://gjs-docs.gnome.org/css/inset-inline-start

HTML structure for the default line-break example.

```html
<section id="default-example">
  <p id="example-element">
    この喫茶店は、いつでもコーヒーの香りを漂わせています。<br />彼女はこの喫茶店で働いて、着々と実力をつけていきました。<br />今では知る人ぞ知る、名人です。
  </p>
</section>
```

--------------------------------

### padding-inline-end syntax examples

Source: https://gjs-docs.gnome.org/css/padding

Various syntax examples including length, percentage, and global values.

```css
/* <length> values */
padding-inline-end: 10px; /* An absolute length */
padding-inline-end: 1em; /* A length relative to the text size */

/* <percentage> value */
padding-inline-end: 5%; /* A padding relative to the block container's width */

/* Global values */
padding-inline-end: inherit;
padding-inline-end: initial;
padding-inline-end: revert;
padding-inline-end: revert-layer;
padding-inline-end: unset;
```

--------------------------------

### Example element structure

Source: https://gjs-docs.gnome.org/css/ratio

HTML structure for a grid example.

```html
<section class="default-example" id="default-example">
  <div class="example-container">
    <div class="transition-all" id="example-element">
      <div>One</div>
      <div>Two</div>
      <div>Three</div>
      <div>Four</div>
      <div>Five</div>
    </div>
  </div>
</section>
```

--------------------------------

### Example element CSS styling

Source: https://gjs-docs.gnome.org/css/border-inline-start-width

CSS styling for the example element.

```css
#example-element {
  background-color: palegreen;
  color: black;
  border: 0 solid crimson;
  padding: 0.75em;
  width: 80%;
  height: 100px;
}
```

--------------------------------

### Syntax examples

Source: https://gjs-docs.gnome.org/css/background-size

Examples of valid border-style values and global values for border-block-end-style.

```css
/* <'border-style'> values */
border-block-end-style: dashed;
border-block-end-style: dotted;
border-block-end-style: groove;

/* Global values */
border-block-end-style: inherit;
border-block-end-style: initial;
border-block-end-style: revert;
border-block-end-style: revert-layer;
border-block-end-style: unset;
```

--------------------------------

### Example: CSS styling with border-inline-start-style

Source: https://gjs-docs.gnome.org/css/border-image-slice

CSS for the example, setting writing-mode to vertical-lr and border-inline-start-style to dashed.

```css
div {
  background-color: yellow;
  width: 120px;
  height: 120px;
}

.exampleText {
  writing-mode: vertical-lr;
  border: 5px solid blue;
  border-inline-start-style: dashed;
}

```

--------------------------------

### padding-top default example structure

Source: https://gjs-docs.gnome.org/css/padding-block

HTML structure for a default padding-top example.

```html
<section id="default-example">
  <div class="transition-all" id="example-element">
    <div class="box">
      Far out in the uncharted backwaters of the unfashionable end of the
      western spiral arm of the Galaxy lies a small unregarded yellow sun.
    </div>
  </div>
</section>
```

--------------------------------

### Try it: CSS for example element

Source: https://gjs-docs.gnome.org/css/attr

CSS styling for the interactive example element, setting background color, image, and repeat.

```css
#example-element {
  background-color: navajowhite;
  background-image: url("/shared-assets/images/examples/star.png");
  background-repeat: no-repeat;
  height: 100%;
}

```

--------------------------------

### Example showing different delays

Source: https://gjs-docs.gnome.org/css/transform-function/translate

A complete example demonstrating different transition delays applied to multiple properties.

```html
<div class="box delay-1">0.5 seconds</div>

<div class="box delay-2">2 seconds</div>

<div class="box delay-3">4 seconds</div>

<button id="change">Change</button>
```

```css
.box {
  margin: 20px;
  padding: 10px;
  display: inline-block;
  width: 100px;
  height: 100px;
  background-color: red;
  font-size: 18px;
  transition-property: background-color, font-size, transform, color;
  transition-timing-function: ease-in-out;
  transition-duration: 3s;
}

.transformed-state {
  transform: rotate(270deg);
  background-color: blue;
  color: yellow;
  font-size: 12px;
  transition-property: background-color, font-size, transform, color;
  transition-timing-function: ease-in-out;
  transition-duration: 3s;
}

.delay-1 {
  transition-delay: 0.5s;
}

.delay-2 {
  transition-delay: 2s;
}

.delay-3 {
  transition-delay: 4s;
}
```

```javascript
function change() {
  const elements = document.querySelectorAll("div.box");
  for (const element of elements) {
    element.classList.toggle("transformed-state");
  }
}

const changeButton = document.querySelector("#change");
changeButton.addEventListener("click", change);
```

--------------------------------

### Basic example: HTML

Source: https://gjs-docs.gnome.org/css/attr

HTML for the basic example, a single div element.

```html
<div></div>

```

--------------------------------

### Usage examples of env()

Source: https://gjs-docs.gnome.org/css/%40media/prefers-reduced-data

Examples demonstrating how to use env() for line-height and margin properties with fallback values.

```css
line-height: env(preferred-text-scale, 2);
margin: env(safe-area-inset-top, 0) env(safe-area-inset-right, auto)
  env(safe-area-inset-bottom, 3em) env(safe-area-inset-left, auto);
```

--------------------------------

### Default example HTML structure

Source: https://gjs-docs.gnome.org/css/background-position-y

HTML structure for the default example element.

```html
<section class="default-example" id="default-example">
  <div class="transition-all" id="example-element">
    This is a box with a border around it.
  </div>
</section>
```

--------------------------------

### Try it: CSS styling for example element

Source: https://gjs-docs.gnome.org/css/border-image-slice

CSS styling for the interactive example element, including background, border, and unicode-bidi.

```css
#example-element {
  background-color: #eeeeee;
  color: black;
  border: 0.75em solid;
  padding: 0.75em;
  width: 80%;
  height: 100px;
  unicode-bidi: bidi-override;
}

```

--------------------------------

### Example element structure and styling

Source: https://gjs-docs.gnome.org/css/%40import/layer_function

HTML structure and corresponding CSS for a default example element.

```html
<section class="default-example" id="default-example">
  <div class="transition-all" id="example-element"></div>
</section>
```

```css
#default-example {
  background: #ffee99;
}

#example-element {
  background: linear-gradient(to bottom right, #ff5522, #0055ff);
  width: 100%;
  height: 100%;
}
```

--------------------------------

### border-left-width syntax examples

Source: https://gjs-docs.gnome.org/css/border-inline-start-width

Various syntax examples including keywords, length values, and global keywords.

```css
/* Keyword values */
border-left-width: thin;
border-left-width: medium;
border-left-width: thick;

/* <length> values */
border-left-width: 10em;
border-left-width: 3vmax;
border-left-width: 6px;

/* Global keywords */
border-left-width: inherit;
border-left-width: initial;
border-left-width: revert;
border-left-width: revert-layer;
border-left-width: unset;
```

--------------------------------

### Try it: example element HTML

Source: https://gjs-docs.gnome.org/css/transform-function/perspective

HTML structure for the interactive example element, an image with class transition-all.

```html
<section id="default-example">
  <img
    class="transition-all"
    id="example-element"
    src="/shared-assets/images/examples/firefox-logo.svg"
    width="200" />
</section>

```

--------------------------------

### Syntax examples for scroll-margin-top

Source: https://gjs-docs.gnome.org/css/scroll-margin-left

Examples of length values and global values for the scroll-margin-top property.

```css
/* <length> values */
scroll-margin-top: 10px;
scroll-margin-top: 1em;

/* Global values */
scroll-margin-top: inherit;
scroll-margin-top: initial;
scroll-margin-top: revert;
scroll-margin-top: revert-layer;
scroll-margin-top: unset;
```

--------------------------------

### Syntax examples for prefix descriptor

Source: https://gjs-docs.gnome.org/css/%3Auser-invalid

Examples showing different types of values that can be assigned to the prefix descriptor.

```css
/* <symbol> value: string, image, or identifier */
prefix: "»";
prefix: "Page ";
prefix: url("bullet.png");
```

--------------------------------

### CSS for transition example

Source: https://gjs-docs.gnome.org/css/transform-function/translate

The CSS styles for the default transition example, including the hover state.

```css
#example-element {
  background-color: #e4f0f5;
  color: black;
  padding: 1rem;
  border-radius: 0.5rem;
  font: 1em monospace;
  width: 100%;
  transition: margin-right 2s;
}

#default-example:hover > #example-element {
  background-color: #990099;
  color: white;
  margin-right: 40%;
}
```

--------------------------------

### Basic example implementation

Source: https://gjs-docs.gnome.org/css/atan2

HTML and CSS for a basic background-position-x implementation.

```html
<div></div>
```

```css
div {
  width: 300px;
  height: 300px;
  background-color: skyblue;
  background-image: url("https://mdn.dev/archives/media/attachments/2020/07/29/17350/3b4892b7e820122ac6dd7678891d4507/firefox.png");
  background-repeat: no-repeat;
  background-position-x: center;
  background-position-y: bottom;
}
```

--------------------------------

### CSS orphans syntax examples

Source: https://gjs-docs.gnome.org/css/object-position

Examples of setting integer values and global keywords for the orphans property.

```css
/* <integer> values */
orphans: 2;
orphans: 3;

/* Global values */
orphans: inherit;
orphans: initial;
orphans: revert;
orphans: revert-layer;
orphans: unset;
```

--------------------------------

### URL fragment identifier example

Source: https://gjs-docs.gnome.org/css/%3Apicture-in-picture

Example of a URL containing a fragment identifier that targets an element with the id 'setup'.

```text
http://www.example.com/help/#setup
```

--------------------------------

### Syntax examples for border-start-start-radius

Source: https://gjs-docs.gnome.org/css/border-left

Various syntax options including length, percentage, and global values.

```css
/* <length> values */
/* With one value the corner will be a circle */
border-start-start-radius: 10px;
border-start-start-radius: 1em;

/* With two values the corner will be an ellipse */
border-start-start-radius: 1em 2em;

/* Global values */
border-start-start-radius: inherit;
border-start-start-radius: initial;
border-start-start-radius: revert;
border-start-start-radius: revert-layer;
border-start-start-radius: unset;
```

--------------------------------

### padding-top default example styles

Source: https://gjs-docs.gnome.org/css/padding-block

CSS styles for the default padding-top example element.

```css
#example-element {
  border: 10px solid #ffc129;
  overflow: hidden;
  text-align: left;
}

.box {
  border: dashed 1px;
}
```

--------------------------------

### 32-bit truncation example

Source: https://gjs-docs.gnome.org/javascript/iteration_protocols

Shows how numbers with more than 32 bits get their most significant bits discarded.

```text
Before: 11100110111110100000000000000110000000000001
After:              10100000000000000110000000000001
```

--------------------------------

### Basic example: CSS with background-position-x and background-position-y

Source: https://gjs-docs.gnome.org/css/attr

CSS for the basic example, setting width, height, background color, image, repeat, and using background-position-x: center and background-position-y: bottom.

```css
div {
  width: 300px;
  height: 300px;
  background-color: skyblue;
  background-image: url("https://mdn.dev/archives/media/attachments/2020/07/29/17350/3b4892b7e820122ac6dd7678891d4507/firefox.png");
  background-repeat: no-repeat;
  background-position-x: center;
  background-position-y: bottom;
}

```

--------------------------------

### Examples of using fill()

Source: https://gjs-docs.gnome.org/javascript/global_objects/typedarray/every

Various ways to use fill() with different start and end index parameters, including negative indices.

```javascript
new Uint8Array([1, 2, 3]).fill(4); // Uint8Array [4, 4, 4]
new Uint8Array([1, 2, 3]).fill(4, 1); // Uint8Array [1, 4, 4]
new Uint8Array([1, 2, 3]).fill(4, 1, 2); // Uint8Array [1, 4, 3]
new Uint8Array([1, 2, 3]).fill(4, 1, 1); // Uint8Array [1, 2, 3]
new Uint8Array([1, 2, 3]).fill(4, -3, -2); // Uint8Array [4, 2, 3]
```

--------------------------------

### Basic Object Initialization

Source: https://gjs-docs.gnome.org/javascript/operators/less_than_or_equal

Examples showing how to create objects using literal syntax, including shorthand property assignment.

```javascript
const object1 = { a: "foo", b: 42, c: {} };

console.log(object1.a);
// Expected output: "foo"

const a = "foo";
const b = 42;
const c = {};
const object2 = { a: a, b: b, c: c };

console.log(object2.b);
// Expected output: 42

const object3 = { a, b, c };

console.log(object3.a);
// Expected output: "foo"
```

--------------------------------

### float: inline-start; example

Source: https://gjs-docs.gnome.org/css/filter-function/invert

Floats the element to the start side of its container based on the writing mode, allowing text and inline elements to wrap around it.

```css
float: inline-start;

```

--------------------------------

### CSS margin-block shorthand

Source: https://gjs-docs.gnome.org/css/css_grid_layout/grid_layout_and_accessibility

This example demonstrates the use of the margin-block shorthand to apply margins to the block dimension, where the first value applies to the start and the second to the end.

```css
.box {
  margin-block: 5px 10px;
}
```

--------------------------------

### Print page example components

Source: https://gjs-docs.gnome.org/css/%3Adefault

HTML, CSS, and JavaScript components to demonstrate printing with the :first pseudo-class.

```html
<p>First Page.</p>
<p>Second Page.</p>
<button>Print!</button>
```

```css
@page :first {
  size: 8.5in 11in;
  margin-left: 3in;
  margin-top: 5in;
}

p {
  page-break-after: always;
  font: 1.2em sans-serif;
}
```

```javascript
document.querySelector("button").addEventListener("click", () => {
  window.print();
});
```

--------------------------------

### Try it: HTML structure for column-rule-style example

Source: https://gjs-docs.gnome.org/css/color_value/hwb

HTML section used by the interactive example to display the multi-column text.

```html
<section id="default-example">
  <p id="example-element">
    London. Michaelmas term lately over, and the Lord Chancellor sitting in
    Lincoln's Inn Hall. Implacable November weather. As much mud in the streets
    as if the waters had but newly retired from the face of the earth, and it
    would not be wonderful to meet a Megalosaurus, forty feet long or so,
    waddling like an elephantine lizard up Holborn Hill.
  </p>
</section>

```

--------------------------------

### CSS grid-row-end with span

Source: https://gjs-docs.gnome.org/css/css_display/in_flow_and_out_of_flow

Example showing the use of span within the grid-row-end property to define an area covering 3 tracks starting from line 1.

```css
.box1 {
  grid-column-start: 1;
  grid-row-start: 1;
  grid-row-end: span 3;
}
```

--------------------------------

### Confirming form details: read-only and read-write textareas

Source: https://gjs-docs.gnome.org/css/%3Apast

Example using :read-only and :read-write to style textareas. The read-only textarea (address) is unstyled to look like a paragraph, while the read-write textarea (delivery instructions) gets a box shadow and border radius.

```css
textarea:read-only {
  border: 0;
}

textarea:read-write {
  box-shadow: inset 1px 1px 3px #cccccc;
  border-radius: 5px;
}

```

```html
<form>
  <fieldset>
    <legend>Confirm details</legend>
    <div>
      <label for="address">Address:</label>
      <textarea id="address" name="address" readonly>
123 Choco Mountain,
Awesome Ridge,
CA</textarea
      >
    </div>
    <div>
      <label for="instructions">Delivery instructions</label>
      <textarea id="instructions" name="instructions"></textarea>
    </div>
  </fieldset>
  <button type="submit">Confirm</button>
</form>

```

--------------------------------

### CSS background-image syntax examples

Source: https://gjs-docs.gnome.org/css/atan

Examples showing how to set single background images, multiple images using gradients, and global values for the background-image property.

```css
/* single image */
background-image: linear-gradient(black, white);
background-image: url("cat-front.png");

/* multiple images */
background-image:
  radial-gradient(circle, transparent 45%, black 48%),
  radial-gradient(ellipse farthest-corner, #fc1c14 20%, #cf15cf 80%);

/* Global values */
background-image: inherit;
background-image: initial;
background-image: revert;
background-image: revert-layer;
background-image: unset;
```

--------------------------------

### Try it: HTML example element

Source: https://gjs-docs.gnome.org/css/integer

HTML markup for the interactive example element, containing a Japanese paragraph with line breaks.

```html
<section id="default-example">
  <p id="example-element">
    この喫茶店は、いつでもコーヒーの香りを漂わせています。<br />彼女はこの喫茶店で働いて、着々と実力をつけていきました。<br />今では知る人ぞ知る、名人です。
  </p>
</section>

```

--------------------------------

### Try it: CSS for example element

Source: https://gjs-docs.gnome.org/css/integer

CSS styling for the interactive example element, setting font family, border, width, and text alignment.

```css
#example-element {
  font-family: "Yu Gothic", YuGothic, Meiryo, "ＭＳ ゴシック", sans-serif;
  border: 2px dashed #999999;
  text-align: left;
  width: 240px;
  font-size: 16px;
}

```

--------------------------------

### Example element HTML structure

Source: https://gjs-docs.gnome.org/css/atan2

HTML structure for the display example.

```html
<section class="display-block" id="default-example">
  <div class="transition-all" id="example-element"></div>
</section>
```

--------------------------------

### Registering a resource with use()

Source: https://gjs-docs.gnome.org/javascript/global_objects/asyncgenerator

Demonstrates the recommended practice of wrapping the resource acquisition expression directly within the use() method to ensure immediate registration.

```javascript
using disposer = new DisposableStack();
const reader = disposer.use(stream.getReader());
```

--------------------------------

### HTML structure for :is() example

Source: https://gjs-docs.gnome.org/css/%3A-moz-last-node

The HTML structure corresponding to the CSS :is() example.

```html
<ol>
  <li>Saturn</li>
  <li>
    <ul>
      <li>Mimas</li>
      <li>Enceladus</li>
      <li>
        <ol>
          <li>Voyager</li>
          <li>Cassini</li>
        </ol>
      </li>
      <li>Tethys</li>
    </ul>
  </li>
  <li>Uranus</li>
  <li>
    <ol>
      <li>Titania</li>
      <li>Oberon</li>
    </ol>
  </li>
</ol>
```

--------------------------------

### Try it: HTML structure for example element

Source: https://gjs-docs.gnome.org/css/attr

HTML structure used in the interactive example, containing a div with id example-element.

```html
<section class="display-block" id="default-example">
  <div class="transition-all" id="example-element"></div>
</section>

```

--------------------------------

### Default example CSS styling

Source: https://gjs-docs.gnome.org/css/background-position-y

CSS styling for the example-element.

```css
#example-element {
  background-color: #eeeeee;
  color: black;
  border: 0.75em solid;
  padding: 0.75em;
  width: 80%;
  height: 100px;
  unicode-bidi: bidi-override;
}
```

--------------------------------

### CSS Style Rule Examples

Source: https://gjs-docs.gnome.org/css

Practical examples of CSS rules applying styles to elements using selectors.

```css
strong {
  color: red;
}

div.menu-bar li:hover > ul {
  display: block;
}
```

--------------------------------

### Styling video cues with ::cue

Source: https://gjs-docs.gnome.org/css/%3A%3Acheckmark

Example showing how to apply styles to video cues and specific internal elements like <u> tags.

```css
video {
  width: 100%;
}

video::cue {
  font-size: 1rem;
  color: yellow;
}

::cue(u) {
  color: red;
}
```

--------------------------------

### CSS for margin-bottom example

Source: https://gjs-docs.gnome.org/css/line-height-step

CSS styling for the container and rows used in the example.

```css
#container {
  width: 300px;
  height: 200px;
  display: flex;
  align-content: flex-start;
  flex-direction: column;
  justify-content: flex-start;
}

.row {
  height: 33.33%;
  display: inline-block;
  border: solid #ce7777 10px;
  background-color: #2b3a55;
  flex-shrink: 0;
}

#example-element {
  border: solid 10px #ffbf00;
  background-color: #2b3a55;
}
```

--------------------------------

### Background image position example

Source: https://gjs-docs.gnome.org/css/scroll-snap-stop

Example of using sign() within background-position, where the result depends on percentage resolution.

```css
div {
  background-position: sign(10%);
}
```

--------------------------------

### grid-column-end example container CSS

Source: https://gjs-docs.gnome.org/css/gradient

CSS styling for the grid container example.

```css
.example-container {
  border: 1px solid #c5c5c5;
  display: grid;
  grid-template-columns: 1fr 1.5fr 1fr;
  grid-template-rows: repeat(3, minmax(40px, auto));
  grid-gap: 10px;
  width: 200px;
}

.example-container > div {
  background-color: rgb(0 0 255 / 0.2);
  border: 3px solid blue;
}

#example-element {
  background-color: rgb(255 0 200 / 0.2);
  border: 3px solid rebeccapurple;
}
```

--------------------------------

### grid-column-end example container HTML

Source: https://gjs-docs.gnome.org/css/gradient

HTML structure for a grid container example.

```html
<section class="default-example" id="default-example">
  <div class="example-container">
    <div class="transition-all" id="example-element">One</div>
    <div>Two</div>
    <div>Three</div>
  </div>
</section>
```

--------------------------------

### Syntax examples for scroll-padding-inline-start

Source: https://gjs-docs.gnome.org/css/scroll-margin-right

Various keyword, length, and global values for the property.

```css
/* Keyword values */
scroll-padding-inline-start: auto;

/* <length> values */
scroll-padding-inline-start: 10px;
scroll-padding-inline-start: 1em;
scroll-padding-inline-start: 10%;

/* Global values */
scroll-padding-inline-start: inherit;
scroll-padding-inline-start: initial;
scroll-padding-inline-start: revert;
scroll-padding-inline-start: revert-layer;
scroll-padding-inline-start: unset;
```

--------------------------------

### Examples of ::view-transition-image-pair() usage

Source: https://gjs-docs.gnome.org/css/%3A%3Aview-transition-image-pair

Provides two example rules: one for the root view transition group and one for a class selector, demonstrating how to set the isolation property.

```css
::view-transition-image-pair(root) {
  isolation: auto;
}

::view-transition-image-pair(.card) {
  isolation: isolate;
}
```

--------------------------------

### Syntax examples

Source: https://gjs-docs.gnome.org/css/ident

Various value types accepted by the inset-block-start property.

```css
/* <length> values */
inset-block-start: 3px;
inset-block-start: 2.4em;
inset-block-start: anchor(end);
inset-block-start: calc(anchor-size(--my-anchor height, 70px) * 2);

/* <percentage>s of the width or height of the containing block */
inset-block-start: 10%;

/* Keyword value */
inset-block-start: auto;

/* Global values */
inset-block-start: inherit;
inset-block-start: initial;
inset-block-start: revert;
inset-block-start: revert-layer;
inset-block-start: unset;
```

--------------------------------

### HTML structure for aspect-ratio example

Source: https://gjs-docs.gnome.org/css/animation-fill-mode

An example section containing an image element.

```html
<section id="default-example">
  <img
    class="transition-all"
    height="640"
    id="example-element"
    src="/shared-assets/images/examples/plumeria.jpg"
    width="466" />
</section>
```

--------------------------------

### Gio.keyfile_settings_backend_new

Source: https://gjs-docs.gnome.org/gio20~2.0

Creates a new keyfile settings backend.

```APIDOC
## Gio.keyfile_settings_backend_new

### Description
Creates a new keyfile settings backend.

### Method
N/A (Function)

### Parameters
- **filename** (string) - Required - The filename.
- **root_path** (string) - Required - The root path.
- **root_group** (string) - Required - The root group.

### Returns
- **GSettingsBackend** - The new backend.
```

--------------------------------

### Basic sign() syntax

Source: https://gjs-docs.gnome.org/css/scroll-snap-stop

Example showing the basic syntax for the sign() function applied to a top property.

```css
/* property: sign( expression ) */
top: sign(20vh - 100px);
```

--------------------------------

### Animation shorthand example 4

Source: https://gjs-docs.gnome.org/css/accent-color

A basic example of the animation shorthand property.

```css
animation: 0.5s linear 1s infinite alternate slide-in;
```

--------------------------------

### Animation shorthand example 3

Source: https://gjs-docs.gnome.org/css/accent-color

A basic example of the animation shorthand property.

```css
animation: 3s linear 1s infinite alternate slide-in;
```

--------------------------------

### Animation shorthand example 2

Source: https://gjs-docs.gnome.org/css/accent-color

A basic example of the animation shorthand property.

```css
animation: 3s linear 1s infinite running slide-in;
```

--------------------------------

### Animation shorthand example 1

Source: https://gjs-docs.gnome.org/css/accent-color

A basic example of the animation shorthand property.

```css
animation: 3s ease-in 1s infinite reverse both running slide-in;
```

--------------------------------

### String.prototype.padStart()

Source: https://gjs-docs.gnome.org/javascript/global_objects/string/padstart

Pads the current string with a given string (repeated if needed) so that the resulting string reaches a specified length. The padding is applied from the start of the string. Returns a new string of the specified length.

```APIDOC
## String.prototype.padStart()

### Description
Pads the current string with another string (repeated if needed) so that the resulting string reaches a given length. The padding is applied from the start of the string. Returns a new string of the specified length.

### Method
padStart

### Syntax
str.padStart(targetLength [, padString])

### Parameters
- **targetLength** (number) - Required - The length of the resulting string once the current string has been padded. If the value is less than or equal to the current string's length, the current string is returned as-is.
- **padString** (string) - Optional - The string to pad the current string with. If this parameter is not provided, it defaults to a space (" "). If the padString is too long to stay within the targetLength, it will be truncated from the end.

### Return Value
A new string of the specified targetLength with the padString applied from the start.

### Example
```javascript
"abc".padStart(10);         // "       abc"
"abc".padStart(10, "foo");  // "foofoofabc"
"abc".padStart(6, "123465"); // "123abc"
"abc".padStart(8, "0");     // "00000abc"
"abc".padStart(1);          // "abc"
```
```

--------------------------------

### Set scroll-snap-align to start

Source: https://gjs-docs.gnome.org/css/scroll-margin-top

Aligns the snap area to the start of the scroll container.

```css
scroll-snap-align: start;
```

--------------------------------

### Creating an object with properties

Source: https://gjs-docs.gnome.org/javascript/operators/less_than_or_equal

Shows how to initialize an object with multiple key-value pairs of different types.

```javascript
const object = {
  foo: "bar",
  age: 42,
  baz: { myProp: 12 },
};
```

--------------------------------

### Absolute specifier examples

Source: https://gjs-docs.gnome.org/javascript/statements/continue

Examples of using HTTP and Data URLs for module imports.

```javascript
// HTTP URLs
import x from "https://example.com/x.js";
// Data URLs
import x from "data:text/javascript,export default 42;";
// Data URLs for JSON modules
import x from 'data:application/json,{"foo":42}' with { type: "json" };
```

--------------------------------

### Logical AND operator examples

Source: https://gjs-docs.gnome.org/javascript/operators/less_than

Various examples of the logical AND operator with different types of operands.

```javascript
a1 = true && true; // t && t returns true
a2 = true && false; // t && f returns false
a3 = false && true; // f && t returns false
a4 = false && 3 === 4; // f && f returns false
a5 = "Cat" && "Dog"; // t && t returns "Dog"
a6 = false && "Cat"; // f && t returns false
a7 = "Cat" && false; // t && f returns false
a8 = "" && false; // f && f returns ""
a9 = false && ""; // f && f returns false
```

--------------------------------

### Operator precedence examples

Source: https://gjs-docs.gnome.org/javascript/operators/less_than

Examples showing how the AND operator (&&) takes precedence over the OR operator (||).

```javascript
true || false && false; // true
true && (false || false); // false
(2 === 3) || (4 < 0) && (1 === 1); // false
```

--------------------------------

### Setting top padding using pixels and percentages

Source: https://gjs-docs.gnome.org/css/padding-block

Example showing class-based application of padding-top.

```css
.content {
  padding-top: 5%;
}
.side-box {
  padding-top: 10px;
}
```

--------------------------------

### HTML example for text-orientation

Source: https://gjs-docs.gnome.org/css/text-decoration-style

Basic HTML paragraph element used in the text-orientation example.

```html
<p>Lorem ipsum dolet semper quisquam.</p>
```

--------------------------------

### Using startsWith() in practice

Source: https://gjs-docs.gnome.org/javascript/global_objects/string/padstart

Shows how startsWith() behaves with different substrings and starting positions within a longer sentence.

```javascript
const str = "To be, or not to be, that is the question.";

console.log(str.startsWith("To be")); // true
console.log(str.startsWith("not to be")); // false
console.log(str.startsWith("not to be", 10)); // true
```

--------------------------------

### marker-start Syntax

Source: https://gjs-docs.gnome.org/css/margin-inline-end

Basic syntax examples for the marker-start property, including the none value, URL references, and global CSS keywords.

```css
marker-start: none;
marker-start: url("markers.svg#arrow");

/* Global values */
marker-start: inherit;
marker-start: initial;
marker-start: revert;
marker-start: revert-layer;
marker-start: unset;
```

--------------------------------

### HTML example element

Source: https://gjs-docs.gnome.org/css/empty-cells

An example section containing an image element to which the filter can be applied.

```html
<section id="default-example">
  <img
    class="transition-all"
    id="example-element"
    src="/shared-assets/images/examples/firefox-logo.svg"
    width="200" />
</section>
```

--------------------------------

### Repeating border images example

Source: https://gjs-docs.gnome.org/css/border-image

A CSS example showing how to apply border-image-repeat to an element.

```css
#bordered {
  width: 12rem;
  margin-bottom: 1rem;
  padding: 1rem;
  border: 40px solid;
  border-image: url("border.png") 27;
  border-image-repeat: stretch; /* Can be changed in the live sample */
}
```

--------------------------------

### container-name syntax examples

Source: https://gjs-docs.gnome.org/css/column-span

Demonstrates the various ways to define container-name, including single names, multiple names, and global values.

```css
container-name: none;

/* A single name */
container-name: my-layout;

/* Multiple names */
container-name: my-page-layout my-component-library;

/* Global Values */
container-name: inherit;
container-name: initial;
container-name: revert;
container-name: revert-layer;
container-name: unset;
```

--------------------------------

### border-inline default example structure

Source: https://gjs-docs.gnome.org/css/border-image-outset

HTML and CSS structure for a default border-inline example.

```html
<section class="default-example" id="default-example">
  <div class="transition-all" id="example-element">
    This is a box with a border around it.
  </div>
</section>
```

```css
#example-element {
  background-color: #eeeeee;
  color: darkmagenta;
  padding: 0.75em;
  width: 80%;
  height: 100px;
  unicode-bidi: bidi-override;
}
```

--------------------------------

### Example: HTML for vertical text

Source: https://gjs-docs.gnome.org/css/border-inline-style

HTML for the border radius with vertical text example.

```html
<div>
  <p class="exampleText">Example</p>
</div>

```

--------------------------------

### Gio.app_info_launch_default_for_uri_async

Source: https://gjs-docs.gnome.org/gio20~2.0

Asynchronously launches the default application for a URI.

```APIDOC
## Gio.app_info_launch_default_for_uri_async

### Description
Asynchronously launches the default application for a URI.

### Method
N/A (Function)

### Parameters
- **uri** (string) - Required - The URI to launch.
- **launch_context** (GAppLaunchContext) - Optional - The launch context.
- **cancellable** (GCancellable) - Optional - A cancellable object.
- **callback** (GAsyncReadyCallback) - Required - Callback to call when finished.
- **user_data** (gpointer) - Optional - User data for the callback.
```

--------------------------------

### Syntax examples

Source: https://gjs-docs.gnome.org/css/basic-shape/path

Common syntax patterns for the border-block-start property.

```css
border-block-start: 1px;
border-block-start: 2px dotted;
border-block-start: medium dashed blue;

/* Global values */
border-block-start: inherit;
border-block-start: initial;
border-block-start: revert;
border-block-start: revert-layer;
border-block-start: unset;
```

--------------------------------

### Example: HTML structure

Source: https://gjs-docs.gnome.org/css/border-image-slice

HTML markup for the example, containing a paragraph with class exampleText.

```html
<div>
  <p class="exampleText">Example text</p>
</div>

```

--------------------------------

### Panel.init

Source: https://gjs-docs.gnome.org/panel1

Initializes the Panel library.

```APIDOC
## Panel.init

### Description
Initializes the Panel library.

### Function Signature
Panel.init()

### Parameters
None.

### Returns
None.
```

--------------------------------

### border-block-end-color syntax examples

Source: https://gjs-docs.gnome.org/css/background-position-y

Examples of setting border-block-end-color using colors and global values.

```css
border-block-end-color: yellow;
border-block-end-color: #f5f6f7;

/* Global values */
border-block-end-color: inherit;
border-block-end-color: initial;
border-block-end-color: revert;
border-block-end-color: revert-layer;
border-block-end-color: unset;
```

--------------------------------

### Basic ellipse() example HTML

Source: https://gjs-docs.gnome.org/css/%40import/layer_function

HTML structure for a basic ellipse shape example.

```html
<div class="box">
  <div class="shape"></div>
  <p>
    One November night in the year 1782, so the story runs, two brothers sat
    over their winter fire in the little French town of Annonay, watching the
    grey smoke-wreaths from the hearth curl up the wide chimney. Their names
    were Stephen and Joseph Montgolfier, they were papermakers by trade, and
    were noted as possessing thoughtful minds and a deep interest in all
    scientific knowledge and new discovery. Before that night—a memorable night,
    as it was to prove—hundreds of millions of people had watched the rising
    smoke-wreaths of their fires without drawing any special inspiration from
    the fact.
  </p>
</div>
```

--------------------------------

### Panel.init

Source: https://gjs-docs.gnome.org/panel1~1

Initializes the Panel library.

```APIDOC
## Panel.init

### Description
Initializes the Panel library.

### Function
Panel.init

### Parameters
None

### Returns
None
```

--------------------------------

### Using startsWith() with basic and positional arguments

Source: https://gjs-docs.gnome.org/javascript/global_objects/string/padstart

Demonstrates checking for a prefix at the start of a string and using the optional position parameter to check for a substring at a specific index.

```javascript
const str = "Saturday night plans";

console.log(str.startsWith("Sat"));
// Expected output: true

console.log(str.startsWith("Sat", 3));
// Expected output: false
```

--------------------------------

### TypeError message examples

Source: https://gjs-docs.gnome.org/javascript/errors/read-only

Examples of the error message format across different JavaScript engines.

```text
TypeError: Cannot assign to read only property 'x' of #<Object> (V8-based)
TypeError: "x" is read-only (Firefox)
TypeError: Attempted to assign to readonly property. (Safari)
```

--------------------------------

### IBus.init

Source: https://gjs-docs.gnome.org/ibus10~1.0

Initializes the IBus library.

```APIDOC
## IBus.init

### Description
Initializes the IBus library.

### Method
Function

### Signature
IBus.init()

### Returns
- **boolean** - True if initialization succeeded.
```

--------------------------------

### ReferenceError message examples

Source: https://gjs-docs.gnome.org/javascript/errors/bad_new_optional

Examples of the error message format across different JavaScript engines.

```text
ReferenceError: "x" is not defined (V8-based & Firefox)
ReferenceError: Can't find variable: x (Safari)
```

--------------------------------

### Colorhug.device_open_full

Source: https://gjs-docs.gnome.org/colorhug10

Opens a device with full options.

```APIDOC
## Colorhug.device_open_full

### Description
Opens a Colorhug device with additional options.

### Function Signature
`Colorhug.device_open_full(device, options)`

### Parameters
- **device** (Device) - Required - The device to open.
- **options** (Object) - Required - Additional options.

### Returns
- (boolean) - True if successful, false otherwise.

### Example
```js
const success = Colorhug.device_open_full(device, { mode: Colorhug.DeviceMode.NORMAL });
```
```

--------------------------------

### skewY() basic usage examples

Source: https://gjs-docs.gnome.org/css/transform-function/rotate

Examples showing the skewY() function with different angle units.

```css
transform: skewY(0);
```

```css
transform: skewY(35deg);
```

```css
transform: skewY(-0.06turn);
```

```css
transform: skewY(0.352rad);
```

--------------------------------

### Apply styles to any-link

Source: https://gjs-docs.gnome.org/css/%3Aany-link

Example showing how to apply bold font weight to paragraphs and specific colors to any-link elements.

```css
p {
  font-weight: bold;
}

a:any-link {
  color: forestgreen;
  text-decoration-color: hotpink;
}
```
Tokens:
Raw