Skip to content
Related Articles

Related Articles

Primer CSS Autocomplete

Improve Article
Save Article
  • Last Updated : 02 Jun, 2022
Improve Article
Save Article

Primer CSS is a free open-source CSS framework that’s created upon systems that make the insights of the essential style elements like spacing, typography, and color. This methodical system makes sure its patterns are steady and interoperable with every other. It’s largely reusable and adaptable.  It’s built with GitHub’s design system. Its approach to CSS is governed by object-oriented CSS fundamentals, functional CSS, and BEM design.

Primer CSS autocomplete is mainly utilized to get suggestions of results while typing into an input field such as a search bar. Primer CSS lets us customize the results according to our usage and we can also use various utility classes inside the results.  

Primer CSS classes:

  • autocomplete-label-stacked: The utility is to specify the label to the field where input is given as a block-level element. This is the default view of the labels in autocomplete. 
  • autocomplete-label-inline:  The utility is to specify the label to the field where input is given as an inline element. This class is complementary to the autocomplete-label-stacked.

To make the labels hidden, we can add the class .sr-only to the label and the label will be hidden no matter if it is stacked or inline. 

  • autocomplete-body: This class is used to specify the container which holds the input field and the autocomplete results.
  • autocomplete-results: This class specifies the list of the elements which will be when the input field is clicked.
  • autocomplete-item: This class is used to add the elements which will be referred to as the options in the autocomplete results. The aria-selected attribute determined which item will be displayed in the selected mode (background is changed to blue color).

Primer CSS does not give us the functionality which we can use to change the aria-selected attribute dynamically. For that, we can use some client-side scripting language and add the functionality which will change the color of the item whenever the item will be hovered over or clicked on. 

  • autocomplete-embedded-icon-wrap: This class is added inside the body of the autocomplete and is used to add an icon inside the input field.

Syntax:

<div class="position-relative">
    <label for="" class="autocomplete-label-stacked">...</label>
    <span class="autocomplete-body">
          <div class="form-control autocomplete-embedded-icon-wrap">
            <img src="..." alt="" width="..." height="...">
            <input id=" " class="form-control" type="text"/>
          </div>
          <ul role="listbox" aria-label="Results" class="autocomplete-results">
            <li class="autocomplete-item" aria-selected="true">...</li>
            ...            
          </ul>
    </span>
</div>

Note: Autocomplete items can have avatars or other utility classes to help customize the options. 

Example 1: The below code demonstrates the usage of autocomplete-embedded-icon-wrap along with autocomplete-label-stacked which adds an icon in the search bar.

HTML




<!DOCTYPE html>
<html>
<head>
    <title>Primer CSS Autocomplete</title>
    <link rel="stylesheet" href=
"https://unpkg.com/@primer/css@^18.0.0/dist/primer.css" />
</head>
  
<body>
    <div class="ml-2">
        <h1 class="color-fg-success">GeeksforGeeks</h1>
        <h3>Primer CSS Autocomplete</h3><br />
    </div>
    
    <div class="position-relative">
        <label for="input-2" class="autocomplete-label-stacked ml-3">
              Search by Topic
        </label>
        <span class="autocomplete-body">
            <div class="form-control autocomplete-embedded-icon-wrap ml-3" 
               style="width: 15rem;">
                <img src=
                     alt="" width="15rem" height="15rem">
                <input id="input-2" class="form-control" type="text" 
                       style="border:none;"/>
            </div>
            <ul role="listbox" aria-label="Results" 
                class="autocomplete-results ml-3" 
                style="width:15rem;">
                <li class="autocomplete-item" aria-selected="true">DSA</li>
                <li class="autocomplete-item">Algorithms</li>
                <li class="autocomplete-item">Interview</li>
            </ul>
        </span>
    </div>
</body>
</html>


Output:

 

Example 2: The below code demonstrates how to add avatars or other utility classes inside the autocomplete items.

HTML




<!DOCTYPE html>
<html>
<head>
    <title>Primer CSS Autocomplete</title>
    <link rel="stylesheet" href=
"https://unpkg.com/@primer/css@^18.0.0/dist/primer.css" />
</head>
  
<body>
    <div class="ml-2">
        <h1 class="color-fg-success">GeeksforGeeks</h1>
        <h3>Primer CSS Autocomplete</h3><br />
    </div>
    
    <div class="position-relative">
        <input class="form-control ml-3" type="text" 
               aria-label="Search by user" 
               placeholder="Search by user" />
        <ul role="listbox" aria-label="Results" 
            class="autocomplete-results ml-3" 
            style="width:15rem;">
            <li class="autocomplete-item">
                <img src=
                    width="20" class="avatar mr-1" alt="" />
                <span>GeeksforGeeks</span>
                <span class="text-normal">@gfg</span>
            </li>
            <li class="autocomplete-item">
                <img src="https://github.com/primer.png" 
                     width="20" class="avatar mr-1" alt="" />
                <span>Primer CSS</span>
                <span class="text-normal">@primer_css</span>
            </li>
            <li class="autocomplete-item" aria-selected="true">
                <img src="https://github.com/github.png" 
                     width="20" class="avatar mr-1" alt="" />
                <span>GitHub Inc.</span>
                <span class="text-normal">@github</span>
            </li>
        </ul>
    </div>
</body>
</html>


Output:

 

Reference: https://primer.style/css/components/autocomplete


My Personal Notes arrow_drop_up
Related Articles

Start Your Coding Journey Now!