Tile Component

The Tile component is a versatile React component that represents a selectable tile element, which can display an icon, image, or text, and allows user interaction.

Table of Contents

• Tile Component
  • Table of Contents
  • Installation
  • Usage
  • Props
  • Example
  • Contributing

Installation

To use the Tile component in your React application, follow these steps:

npm install @bolttech/frontend-foundations @bolttech/atoms-tile

or

yarn add @bolttech/frontend-foundations @bolttech/atoms-tile

Once you have the required dependencies installed, you can start using the Tile component in your React application.

Usage

The Tile component provides a flexible way to create selectable tiles with various content types, such as icons, images, and text. Users can interact with the tiles, and you can track the selected state using the onClick prop.

To use the component, import it and include it in your JSX:

import React from 'react';
import { Tile } from '@bolttech/atoms-tile';
import { bolttechTheme, BolttechThemeProvider } from '@bolttech/frontend-foundations'; // You can import your Tile component here

function App() {
  const handleTileSelect = (isSelected) => {
    console.log(`Tile selected: ${isSelected}`);
  };

  return (
    <BolttechThemeProvider theme={bolttechTheme}>
      <Tile icon="star" subtitle="sub" title="Favorite" onClick={handleTileSelect} dataTestId="favorite-tile" />
      <Tile image={<img src="image-url.jpg" alt="Image" />} title="Image Tile" onClick={handleTileSelect} dataTestId="image-tile" variant="image" />
    </BolttechThemeProvider>
  );
}

export default App;

Props

The Tile component accepts the following props:

| Prop | Type | Description | | ------------ | -------------------------------------- | --------------------------------------------------------------------------- | --------- | --------------------------------------------- | | id | string | The id attribute for the tile container. | | dataTestId | string | The data-testid attribute for testing purposes. | | variant | TileVariants | The visual style variant of the tile. | | icon | MaterialSymbol | The name of the icon to display in the tile (if using icon variant). | | image | React.ReactElement<HTMLImageElement> | The JSX element representing the image (if using image variant). | | subtitle | string | The text that will be rendered below your title icon or image. | | title | string | The text that will be rendered below your icon or image. | | selected | boolean | Whether the tile is selected or not. Default is false. | | onClick | (isSelected: boolean) => void | A callback function to be executed when the tile is selected or deselected. | | disabled | boolean | Whether the tile should be disabled. | | alignment | 'left' | 'right' | 'center' | The alignment of the content within the tile. | | infoLabel | string | The label of the info area. | | infoIcon | MaterialSymbol | Icon from the info section. |

Example

Here's an example of using the Tile component:

      <Tile
        icon="star"
        subtitle="sub"
        title="Favorite"
        onClick={handleTileSelect}
        dataTestId="favorite-tile"
      />
      <Tile
        image={<img src="image-url.jpg" alt="Image"/>}
        title="Image Tile"
        onClick={handleTileSelect}
        dataTestId="image-tile"
        variant="image"
      />

This will render two selectable tiles with different content types.

Contributing

Contributions to the Tile component are welcome. If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the project's Bitbucket repository.