パンくずリストブロック

Breadcrumbコンポーネントは、ReactとTypeScriptで構築された完全にカスタマイズ可能でアクセシブルなナビゲーションブレッドクラムです。モダンなデザインパターン、柔軟なカスタマイズオプション、カスタムナビゲーションアイテムのサポートを備えた完全なブレッドクラムナビゲーションインターフェースを提供します。

---

🚀 インストール

npm install @nodeblocks/frontend-breadcrumb-block@0.1.0

---

📖 使用法

import {Breadcrumbs} from '@nodeblocks/frontend-breadcrumb-block';

基本的な使用法

  function BasicBreadcrumb() {
    return (
      <Breadcrumbs>
        <Breadcrumbs.BreadcrumbItem url="#home">
            Home
        </Breadcrumbs.BreadcrumbItem>
        <Breadcrumbs.BreadcrumbChevron />
        <Breadcrumbs.BreadcrumbItem url="#products">
            Products
        </Breadcrumbs.BreadcrumbItem>
      </Breadcrumbs>
    );
  }

高度な使用法

  function AdvancedBreadcrumb() {
    return (
      <Breadcrumbs>
        {({ defaultBlocks, defaultBlockOrder }) => ({
          blocks: {
            ...defaultBlocks,
            
            // 🏠 Home breadcrumb with props override
            home: {
              ...defaultBlocks.breadcrumbItem,
              props: {
                ...defaultBlocks.breadcrumbItem.props,
                url: "#home",
                children: "🏠 Home",
                style: { fontWeight: 'bold' }
              },
            },
            
            // 📱 Products breadcrumb with custom styling
            products: {
              ...defaultBlocks.breadcrumbItem,
              props: {
                ...defaultBlocks.breadcrumbItem.props,
                url: "#products",
                children: "📱 Products",
                className: "custom-product-link"
              },
            },
            
            // 🔍 Full block override with custom component
            search: (
              <span style={{ 
                color: '#fff', 
                backgroundColor: '#007bff', 
                padding: '4px 8px', 
                borderRadius: '4px',
                fontSize: '12px'
              }}>
                🔍 Search Results
              </span>
            ),
            
            // 🎨 Custom chevron override
            breadcrumbChevron: (
              <span style={{ 
                margin: '0 8px',
                color: '#ffd700',
                fontWeight: 'bold'
              }}>
                →
              </span>
            ),
            
            // 📄 Current page (no link)
            currentPage: (
              <span style={{ 
                color: '#ccc',
                fontStyle: 'italic'
              }}>
                Current Page
              </span>
            ),
          },
          blockOrder: ['home', 'products', 'search', 'currentPage'],
        })}
      </Breadcrumbs>
    );
  }

---

🔧 プロパティリファレンス

メインコンポーネントプロパティ

プロパティ	型	デフォルト	説明
className	string	undefined	ブレッドクラムコンテナのスタイリング用の追加CSSクラス名
children	BlocksOverride	undefined	デフォルトブロックをオーバーライドするか、カスタムブレッドクラムアイテムを追加する関数

注意: メインコンポーネントはすべてのHTML nav要素プロパティを継承します。

サブコンポーネント

Breadcrumbコンポーネントは複数のサブコンポーネントを提供します。すべてのサブコンポーネントは、メインコンポーネントのコンテキストからデフォルト値を受け取り、プロパティを通じてこれらの値をオーバーライドできます。

Breadcrumbs.BreadcrumbItem

プロパティ	型	デフォルト	説明
url	string	必須	ブレッドクラムリンクのURL/href
children	ReactNode	必須	ブレッドクラムアイテムテキストとして表示するコンテンツ

注意: このコンポーネントはすべてのHTML a要素プロパティを継承します。

Breadcrumbs.BreadcrumbChevron

このコンポーネントはプロパティを受け取らず、シェブロンセパレーターをレンダリングします。

---

🔧 TypeScriptサポート

包括的な型定義による完全なTypeScriptサポート：

import {Breadcrumbs} from '@nodeblocks/frontend-breadcrumb-block';
import {ComponentProps, ReactNode} from 'react';

// Main component interface
interface BreadcrumbProps extends Omit<ComponentProps<'nav'>, 'children'> {
  children?: BlocksOverride<DefaultBlocks, CustomBlocks>;
  className?: string;
}

// BreadcrumbItem interface
interface BreadcrumbItemProps extends Omit<ComponentProps<'a'>, 'children'> {
  url: string;
  children: ReactNode;
}

// Usage example with data structure
interface BreadcrumbItem {
  key: string;
  url: string;
  label: string;
}

const breadcrumbItems: BreadcrumbItem[] = [
  { key: 'home', url: '#home', label: 'Home' },
  { key: 'products', url: '#products', label: 'Products' },
  { key: 'current', url: '#products/laptop', label: 'Laptop' },
];

// Example with anchor props
function AdvancedBreadcrumb() {
  return (
    <Breadcrumbs>
      {breadcrumbItems.map((item, index) => (
        <>
          <Breadcrumbs.BreadcrumbItem key={item.key} url={item.url}>
            {item.label}
          </Breadcrumbs.BreadcrumbItem>
          {index < breadcrumbItems.length - 1 && <Breadcrumbs.BreadcrumbChevron />}
        </>
      ))}
    </Breadcrumbs>
  );
}

---

React、TypeScript、モダンWebスタンダードを使用して❤️で構築されました。