Getting StartedInstallationSupportChangelogGithubFrameworksAngularVueReactDemosFoundationThemesInternationalizationTypographyIconsLayoutGetting StartedBlockInlineGridComponentsAccordionAlertAlert GroupBadgeBreadcrumbButtonButton GroupButton ExpandButton HandleButton IconButton Icon GroupButton SortCardCheckboxColorData GridDateDialogDividerDrawerDropdownFileFormsForm InteractionsForm ValidationHeaderInputMenuMonthNavPaginationPasswordProgress BarProgress CircleRadioRangeSearchSelectShellSwitchTabsTagTextareaTimeToastTooltipData GridGetting StartedFooterPlaceholderAsyncResponsiveScroll HeightPaginationBordersHoverColumn AlignmentColumn WidthColumn FixedColumn StickyColumn VisibilityRow HeaderRow Multi SelectRow Single SelectRow HeightRow ActionRow Action BulkRow StickyRow StripeRow FixedRow SortRow Groups

Grid Row Action Bulk

Row bulk actions work in a similar way to single actions, but use bp-checkbox to identify which elements the action should be applied to.

Action Bulk

Column 0Column 1Column 2Column 3Column 4Cell 0-0Cell 0-1Cell 0-2Cell 0-3Cell 0-4Cell 1-0Cell 1-1Cell 1-2Cell 1-3Cell 1-4Cell 2-0Cell 2-1Cell 2-2Cell 2-3Cell 2-4Cell 3-0Cell 3-1Cell 3-2Cell 3-3Cell 3-4Cell 4-0Cell 4-1Cell 4-2Cell 4-3Cell 4-4Cell 5-0Cell 5-1Cell 5-2Cell 5-3Cell 5-4Cell 6-0Cell 6-1Cell 6-2Cell 6-3Cell 6-4
code
<script type="module">
  import '@blueprintui/grid/include/core.js';
  import '@blueprintui/grid/include/keynav.js';
  import '@blueprintui/components/include/checkbox.js';
  import '@blueprintui/components/include/search.js';
  import '@blueprintui/components/include/button-icon-group.js';
  import '@blueprintui/icons/shapes/highlighter.js';
  import '@blueprintui/icons/shapes/attachment.js';
  import '@blueprintui/icons/shapes/plus.js';
  import '@blueprintui/icons/shapes/trash.js';
</script>
<section bp-layout="block gap:xs">
  <div bp-layout="inline gap:xs">
    <bp-search aria-label="search column" placeholder="search" style="width: 250px"></bp-search>
    <bp-button-icon-group>
      <bp-button-icon shape="plus" aria-label="add"></bp-button-icon>
      <bp-button-icon shape="attachment" aria-label="attach"></bp-button-icon>
      <bp-button-icon shape="highlighter" aria-label="highlight"></bp-button-icon>
    </bp-button-icon-group>
    <bp-button-icon-group bp-layout="inline:end">
      <bp-button-icon shape="trash" aria-label="delete"></bp-button-icon>
    </bp-button-icon-group>
  </div>
  <bp-grid aria-label="row action datagrid">
    <bp-grid-column width="max-content">
      <bp-checkbox aria-label="select all"></bp-checkbox>
    </bp-grid-column>
    <bp-grid-column>Column 0</bp-grid-column>
    <bp-grid-column>Column 1</bp-grid-column>
    <bp-grid-column>Column 2</bp-grid-column>
    <bp-grid-column>Column 3</bp-grid-column>
    <bp-grid-column>Column 4</bp-grid-column>

    <bp-grid-row>
      <bp-grid-cell>
        <bp-checkbox aria-label="select row"></bp-checkbox>
      </bp-grid-cell>
      <bp-grid-cell>Cell 0-0</bp-grid-cell>
      <bp-grid-cell>Cell 0-1</bp-grid-cell>
      <bp-grid-cell>Cell 0-2</bp-grid-cell>
      <bp-grid-cell>Cell 0-3</bp-grid-cell>
      <bp-grid-cell>Cell 0-4</bp-grid-cell>
    </bp-grid-row>

    <bp-grid-row>
      <bp-grid-cell>
        <bp-checkbox aria-label="select row"></bp-checkbox>
      </bp-grid-cell>
      <bp-grid-cell>Cell 1-0</bp-grid-cell>
      <bp-grid-cell>Cell 1-1</bp-grid-cell>
      <bp-grid-cell>Cell 1-2</bp-grid-cell>
      <bp-grid-cell>Cell 1-3</bp-grid-cell>
      <bp-grid-cell>Cell 1-4</bp-grid-cell>
    </bp-grid-row>

    <bp-grid-row>
      <bp-grid-cell>
        <bp-checkbox aria-label="select row" checked></bp-checkbox>
      </bp-grid-cell>
      <bp-grid-cell>Cell 2-0</bp-grid-cell>
      <bp-grid-cell>Cell 2-1</bp-grid-cell>
      <bp-grid-cell>Cell 2-2</bp-grid-cell>
      <bp-grid-cell>Cell 2-3</bp-grid-cell>
      <bp-grid-cell>Cell 2-4</bp-grid-cell>
    </bp-grid-row>

    <bp-grid-row>
      <bp-grid-cell>
        <bp-checkbox aria-label="select row"></bp-checkbox>
      </bp-grid-cell>
      <bp-grid-cell>Cell 3-0</bp-grid-cell>
      <bp-grid-cell>Cell 3-1</bp-grid-cell>
      <bp-grid-cell>Cell 3-2</bp-grid-cell>
      <bp-grid-cell>Cell 3-3</bp-grid-cell>
      <bp-grid-cell>Cell 3-4</bp-grid-cell>
    </bp-grid-row>

    <bp-grid-row>
      <bp-grid-cell>
        <bp-checkbox aria-label="select row" checked></bp-checkbox>
      </bp-grid-cell>
      <bp-grid-cell>Cell 4-0</bp-grid-cell>
      <bp-grid-cell>Cell 4-1</bp-grid-cell>
      <bp-grid-cell>Cell 4-2</bp-grid-cell>
      <bp-grid-cell>Cell 4-3</bp-grid-cell>
      <bp-grid-cell>Cell 4-4</bp-grid-cell>
    </bp-grid-row>

    <bp-grid-row>
      <bp-grid-cell>
        <bp-checkbox aria-label="select row"></bp-checkbox>
      </bp-grid-cell>
      <bp-grid-cell>Cell 5-0</bp-grid-cell>
      <bp-grid-cell>Cell 5-1</bp-grid-cell>
      <bp-grid-cell>Cell 5-2</bp-grid-cell>
      <bp-grid-cell>Cell 5-3</bp-grid-cell>
      <bp-grid-cell>Cell 5-4</bp-grid-cell>
    </bp-grid-row>

    <bp-grid-row>
      <bp-grid-cell>
        <bp-checkbox aria-label="select row"></bp-checkbox>
      </bp-grid-cell>
      <bp-grid-cell>Cell 6-0</bp-grid-cell>
      <bp-grid-cell>Cell 6-1</bp-grid-cell>
      <bp-grid-cell>Cell 6-2</bp-grid-cell>
      <bp-grid-cell>Cell 6-3</bp-grid-cell>
      <bp-grid-cell>Cell 6-4</bp-grid-cell>
    </bp-grid-row>
  </bp-grid>
</section>

Install

NPM

// npm package
import '@blueprintui/components/include/undefined.js';

CDN

<script type="module">
  import 'https://cdn.jsdelivr.net/npm/@blueprintui/components/include/undefined.js/+esm';
</script>

bp-grid-row

Properties

NameTypesDescription
selectedbooleanselected visual state
position'fixed' | 'sticky' | ''position individual row relative to the grid scroll container
rolestring

Attributes

NameTypesDescription
selectedbooleanselected visual state
position'fixed' | 'sticky' | ''position individual row relative to the grid scroll container

CSS Properties

NameTypesDescription
--border-top
--border-bottom
--background
--min-height

bp-grid

Properties

NameTypesDescription
i18ni18n string options
heightstringmax height for grid container
columnLayout'fixed' | 'flex'column layout determines initial column width calculation
rowStylePermutations< 'hover' | 'stripe' | 'border' >determines the visual style for rows
columnStylePermutations<'hover' | 'border'>determines the visual style for columns
selectable'multi' | 'single' | nullinitializes grid to appropriate aria/a11y settings for selections
scrollLockbooleandisables scroll container
gridHTMLElement[][]
rolestring

Attributes

NameTypesDescription
i18ni18n string options
heightstringmax height for grid container
column-layout'fixed' | 'flex'column layout determines initial column width calculation
row-stylePermutations< 'hover' | 'stripe' | 'border' >determines the visual style for rows
column-stylePermutations<'hover' | 'border'>determines the visual style for columns
selectable'multi' | 'single' | nullinitializes grid to appropriate aria/a11y settings for selections
scroll-lockbooleandisables scroll container
range-selectionboolean

CSS Properties

NameTypesDescription
--background
--body-height
--scrollbar-background
--scrollbar-thumb-background
--column-height
--row-height
--scroll-padding-top
--row-content-visibility

bp-grid-column

Properties

NameTypesDescription
widthstringcontrol width of grid column via numeric or CSS value types
position'sticky' | 'fixed'position individual column relative to the grid scroll container
alignment'start' | 'center' | 'end'align column content and corresponding column cells
rolestring
ariaSortstring

Attributes

NameTypesDescription
widthstringcontrol width of grid column via numeric or CSS value types
position'sticky' | 'fixed'position individual column relative to the grid scroll container
alignment'start' | 'center' | 'end'align column content and corresponding column cells

CSS Properties

NameTypesDescription
--min-height
--min-width
--justify-content
--padding-block
--padding-inline
--background
--font-size
--color

Slots

NameTypesDescription
defaultcolumn content

bp-grid-cell

Properties

NameTypesDescription
rolestring

CSS Properties

NameTypesDescription
--border-right
--border-left
--min-height
--min-width
--font-size
--justify-content
--padding-block
--padding-inline-start
--padding-inline-end
--color

Slots

NameTypesDescription
defaultcell content