ip-breadcrumb

ip-breadcrumb - Web Component Breadcrumb for Stencil

ip-breadcrumb is a highly customizable and reusable breadcrumb (breadcrumb trail) web component built with Stencil. A breadcrumb is a user interface element that helps users navigate through a hierarchical website structure.

Installation

Ensure you have Node.js installed on your machine. If not, you can download it from nodejs.org.

1. Clone this repository:

git clone https://github.com/Ipedis-technicalTeam/ip-breadcrumb.git
cd ip-breadcrumb

2. run the project:

npm install
npm run start

Usage

To use the ip-breadcrumb web component in your Stencil project, follow these steps:

1. Install the ip-breadcrumb component as a dependency in your Stencil project:

npm install --save path/to/your/ip-breadcrumb

2. Import the component in your Stencil code:

import '../node_modules/ip-accordeon/dist/ip-accordeon/ip-accordeon.esm';

3. Use the component in your Stencil template:

<ip-breadcrumb items='[{"text": "Home", "url": "/"}, {"text": "Products", "url": "/products"}, {"text": "Shoes", "url": "/products/shoes"}]'></ip-breadcrumb>

You can customize the breadcrumb by passing an array of objects to the items property. Each object represents a breadcrumb item with a label and a URL.

Customization

The ip-breadcrumb web component provides various properties and events for customization. Refer to the component's documentation for detailed information on these properties and events.

Styling

You can style the ip-breadcrumb component by using CSS custom properties or by targeting the component's shadow DOM. Refer to the Stencil documentation on styling for more information.