kibana/packages/home/sample_data_card
Spencer 6c438b331c
[api-docs] follow the correct schema for frontmatter (#138348)
* [api-docs] follow the correct schema for frontmatter

* rename non-generated summary: usage

* fix yaml comment syntax
2022-08-10 17:17:50 -05:00
..
src [eslint] fix and skip violations for cross-boundary imports (#136911) 2022-07-29 13:57:55 -05:00
BUILD.bazel chore(NA): allow packages to not have an obligation for a src folder on packages (#138038) 2022-08-08 15:54:05 +01:00
jest.config.js [home] Sample Data Tab w/ callout UI (#136790) 2022-07-25 18:34:32 -07:00
package.json [home] Sample Data Tab w/ callout UI (#136790) 2022-07-25 18:34:32 -07:00
README.mdx [api-docs] follow the correct schema for frontmatter (#138348) 2022-08-10 17:17:50 -05:00
tsconfig.json [home] Sample Data Tab w/ callout UI (#136790) 2022-07-25 18:34:32 -07:00

---
id: home/SampleData/Cards
slug: /home/sample-data/cards
title: Sample Data Cards
description: A component that displays Sample Data Sets as cards and grid of cards.
tags: ['home', 'component', 'sample-data']
date: 2022-06-30
---

This package contains a pair of components.  The first displays a Sample Data Set as a card which displays the Sample Data Set's name, description, and image as well as functions to install, uninstall and navigate to Saved Objects associated with the data set.  The other component fetches a list of Sample Data Sets and displays them as a grid, which also responds to install and uninstall events.

## API

| Export | Description |
|---|---|
| `SampleDataCard` | Fetches and displays a grid of Sample Data Sets as `SampleDataCard` components. |
| `SampleDataCard` | A card component representing a Sample Data Set, which can install, uninstall and navigate relevant objects from a Sample Data Set. |
| `SampleDataCardProvider` | Provides contextual services to `KibanaNoDataPage`. |
| `SampleDataCardKibanaProvider` | Maps Kibana dependencies to provide contextual services to `KibanaNoDataPage`. |

## EUI Promotion Status

This component is not currently considered for promotion to EUI.