Files
OpenMQTT-Gateway/docs/.vitepress/components/BoardEnvironmentTable.vue
T
8273617c17 [DOCS] Migrate documentation from VuePress 1.x to VitePress (#2299)
- Replace VuePress 1.9.10 with VitePress 1.6.4
- Convert config from CommonJS to ESM TypeScript (config.mts)
- Convert shared Theengs nav config to ESM (commonConfig.mts)
- Rewrite BoardEnvironmentTable in Vue 3 Composition API
- Rewrite FlashEnvironmentSelector in Vue 3 Composition API
- Enable built-in local search and dark mode
- Add medium-zoom for image zoom
- Use VitePress CSS variables for dark mode compatibility
- Update CI script paths from .vuepress to .vitepress
- Update .gitignore for VitePress build artifacts
- Rename README.md files to index.md (VitePress convention)
- Fix markdown compatibility (angle-bracket escaping, image paths)
- Drop PWA plugin (not needed)

Co-authored-by: Florian <1technophile@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-30 07:00:20 -05:00

778 lines
19 KiB
Vue

<template>
<div class="board-environment-list">
<div v-if="loading" class="custom-block tip">
<p class="custom-block-title">
<span class="loading-spinner" aria-label="Loading"></span>
Loading supported environments...
</p>
</div>
<div v-if="error" class="custom-block danger">
<p class="custom-block-title">Error</p>
<p>{{ error }}</p>
</div>
<div v-if="!loading && !error">
<!-- Search and Filter Bar -->
<div class="filter-bar">
<div class="search-box">
<svg class="search-icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="11" cy="11" r="8"/><line x1="21" y1="21" x2="16.65" y2="16.65"/></svg>
<input
v-model="searchQuery"
type="text"
placeholder="Search by name, description, module..."
class="search-input"
aria-label="Search boards">
<button
v-if="searchQuery"
class="search-clear"
@click="searchQuery = ''"
aria-label="Clear search">
<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="18" y1="6" x2="6" y2="18"/><line x1="6" y1="6" x2="18" y2="18"/></svg>
</button>
</div>
<div class="filter-groups">
<div class="filter-group">
<span class="filter-group__label">MCU:</span>
<div class="filter-chips">
<button
v-for="mcu in mcuFilters"
:key="mcu"
:class="['filter-chip', { 'filter-chip--active': activeMcuFilter === mcu }]"
@click="toggleMcuFilter(mcu)">
{{ mcu }}
</button>
</div>
</div>
<div class="filter-group">
<span class="filter-group__label">Gateway:</span>
<div class="filter-chips">
<button
v-for="gw in gatewayFilters"
:key="gw.key"
:class="['filter-chip', { 'filter-chip--active': activeGatewayFilter === gw.key }]"
@click="toggleGatewayFilter(gw.key)">
{{ gw.label }}
</button>
</div>
</div>
</div>
<div v-if="hasActiveFilters" class="filter-status">
<span>Showing {{ filteredBoards.length }} of {{ boards.length }} boards</span>
<button class="filter-clear" @click="clearFilters">Clear all filters</button>
</div>
</div>
<!-- No Results -->
<div v-if="filteredBoards.length === 0" class="no-results">
<p>No boards match your filters.</p>
<button class="filter-clear" @click="clearFilters">Clear all filters</button>
</div>
<div class="boards-grid">
<article
v-for="board in filteredBoards"
:key="board.environment"
class="board-card"
@click="openSelector(board.environment)">
<div class="board-card__image">
<span v-if="popularEnvironments.includes(board.environment)" class="popular-badge">Popular</span>
<img
:src="getBoardImageUrl(board)"
:alt="board.environment"
loading="lazy">
</div>
<div class="board-card__content">
<div class="board-card__header">
<h3 class="board-card__title">
<code>{{ board.environment }}</code>
</h3>
<span v-if="board.microcontroller" class="board-card__chip">
{{ board.microcontroller }}
</span>
</div>
<p v-if="board.description" class="board-card__description" v-html="board.description">
</p>
<!-- Modules Section with expand/collapse -->
<div v-if="Array.isArray(board.modules) && board.modules.length" class="board-card__libraries">
<div class="modules-label-row">
<span class="libraries-label">Modules:</span>
<span
v-if="board.modules.length > 2"
class="expand-icon-btn"
@click.stop="toggleModules(board.environment)"
:title="expandedModules[board.environment] ? 'Hide' : 'Show all'">
<svg :class="{rotated: expandedModules[board.environment]}" width="19" height="19" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="9 6 15 12 9 18"/></svg>
</span>
</div>
<Transition name="expand-fade">
<div class="libraries-badges"
:style="expandedModules[board.environment] ? '' : 'max-height: 2.2em; overflow: hidden;'">
<span
v-for="(mod, index) in board.modules"
:key="index"
class="lib-badge">
{{ mod }}
</span>
</div>
</Transition>
</div>
<!-- Libraries Section with expand/collapse -->
<div v-if="Array.isArray(board.libraries) && board.libraries.length" class="board-card__libraries">
<div class="modules-label-row">
<span class="libraries-label">Libraries:</span>
<span
v-if="board.libraries.length > 2"
class="expand-icon-btn"
@click.stop="toggleLibraries(board.environment)"
:title="expandedLibraries[board.environment] ? 'Hide' : 'Show all'">
<svg :class="{rotated: expandedLibraries[board.environment]}" width="19" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="9 6 15 12 9 18"/></svg>
</span>
</div>
<Transition name="expand-fade">
<div class="libraries-badges"
:style="expandedLibraries[board.environment] ? '' : 'max-height: 2.2em; overflow: hidden;'">
<span
v-for="(lib, index) in board.libraries"
:key="index"
class="lib-badge">
{{ lib }}
</span>
</div>
</Transition>
</div>
<div class="board-card__action">
<span class="action-text">More info →</span>
</div>
</div>
</article>
</div>
</div>
</div>
</template>
<script setup lang="ts">
import { ref, reactive, computed, onMounted } from 'vue'
interface Board {
environment: string
description?: string
microcontroller?: string
modules?: string[]
libraries?: string[]
customImg?: string
CustomImg?: string
}
interface GatewayFilter {
key: string
label: string
}
const props = withDefaults(defineProps<{
boardsUrl?: string
selectorPath?: string
}>(), {
boardsUrl: '/boards-info.json',
selectorPath: '/upload/board-selector.html'
})
const boards = ref<Board[]>([])
const loading = ref(false)
const error = ref<string | null>(null)
const expandedModules = reactive<Record<string, boolean>>({})
const expandedLibraries = reactive<Record<string, boolean>>({})
const searchQuery = ref('')
const activeMcuFilter = ref<string | null>(null)
const activeGatewayFilter = ref<string | null>(null)
const popularEnvironments = [
'esp32dev-ble',
'theengs-bridge-v11',
'lilygo-rtl_433',
'lilygo-rtl_433-fsk',
'esp32dev-ir'
]
function buildUrl(path: string): string {
const base = import.meta.env.BASE_URL || '/'
const cleanBase = base.endsWith('/') ? base.slice(0, -1) : base
const cleanPath = path.startsWith('/') ? path : `/${path}`
return `${cleanBase}${cleanPath}`
}
const resolvedBoardsUrl = computed(() => buildUrl(props.boardsUrl))
const resolvedSelectorUrl = computed(() => buildUrl(props.selectorPath))
function getMcuFamily(mcu: string | undefined): string | null {
if (!mcu) return null
const m = mcu.toLowerCase()
if (m.includes('esp32-s3') || m.includes('esp32s3') || m.includes('atoms3') || m.includes('lilygo-t3-s3')) return 'ESP32-S3'
if (m.includes('esp32-c3') || m.includes('esp32c3') || m.includes('lolin_c3') || m.includes('airm2m')) return 'ESP32-C3'
if (m.includes('esp32') || m.includes('m5st') || m.includes('heltec') || m.includes('ttgo') || m.includes('lolin32') || m.includes('pico32') || m.includes('tinypico') || m.includes('feather')) return 'ESP32'
if (m.includes('esp8') || m.includes('nodemcu')) return 'ESP8266'
return 'Other'
}
const mcuFilters = computed<string[]>(() => {
const families: Record<string, boolean> = {}
boards.value.forEach(b => {
const family = getMcuFamily(b.microcontroller)
if (family) families[family] = true
})
return Object.keys(families).sort()
})
const gatewayFilters = computed<GatewayFilter[]>(() => {
const gateways: Record<string, string> = {
BT: 'BLE',
RF: 'RF',
IR: 'IR',
LORA: 'LoRa',
RTL_433: 'RTL_433',
Pilight: 'Pilight'
}
const result: GatewayFilter[] = []
Object.keys(gateways).forEach(key => {
const hasBoards = boards.value.some(b =>
Array.isArray(b.modules) && b.modules.some(m =>
m.toLowerCase().includes(key.toLowerCase())
)
)
if (hasBoards) {
result.push({ key, label: gateways[key] })
}
})
return result
})
const hasActiveFilters = computed(() =>
searchQuery.value || activeMcuFilter.value || activeGatewayFilter.value
)
const filteredBoards = computed<Board[]>(() =>
boards.value.filter(board => {
if (searchQuery.value) {
const q = searchQuery.value.toLowerCase()
const haystack = [
board.environment,
board.description || '',
board.microcontroller || '',
(board.modules || []).join(' ')
].join(' ').toLowerCase()
if (!haystack.includes(q)) return false
}
if (activeMcuFilter.value) {
const family = getMcuFamily(board.microcontroller)
if (family !== activeMcuFilter.value) return false
}
if (activeGatewayFilter.value) {
const key = activeGatewayFilter.value.toLowerCase()
if (!Array.isArray(board.modules) || !board.modules.some(m =>
m.toLowerCase().includes(key)
)) return false
}
return true
})
)
function toggleMcuFilter(mcu: string) {
activeMcuFilter.value = activeMcuFilter.value === mcu ? null : mcu
}
function toggleGatewayFilter(gw: string) {
activeGatewayFilter.value = activeGatewayFilter.value === gw ? null : gw
}
function clearFilters() {
searchQuery.value = ''
activeMcuFilter.value = null
activeGatewayFilter.value = null
}
async function loadBoards() {
loading.value = true
error.value = null
try {
const response = await fetch(resolvedBoardsUrl.value)
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${response.statusText}`)
}
const data = await response.json()
if (!Array.isArray(data)) {
throw new Error('boards-info.json must be an array')
}
boards.value = data
.filter((board: Board) => board && typeof board.environment === 'string')
.sort((a: Board, b: Board) => {
const aPopular = popularEnvironments.includes(a.environment)
const bPopular = popularEnvironments.includes(b.environment)
if (aPopular && !bPopular) return -1
if (!aPopular && bPopular) return 1
return a.environment.localeCompare(b.environment)
})
} catch (err: unknown) {
console.error('Failed to load boards-info:', err)
error.value = err instanceof Error ? err.message : 'Unable to load board information'
} finally {
loading.value = false
}
}
function toggleModules(env: string) {
expandedModules[env] = !expandedModules[env]
}
function toggleLibraries(env: string) {
expandedLibraries[env] = !expandedLibraries[env]
}
function openSelector(environment: string) {
if (!environment) return
const url = `${resolvedSelectorUrl.value}?env=${encodeURIComponent(environment)}`
window.location.href = url
}
function getBoardImageUrl(board: Board): string {
const customImg = board.customImg || board.CustomImg
if (customImg) {
if (customImg.startsWith('http')) {
return customImg
}
return buildUrl(customImg)
}
return buildUrl('/img/microcontroller.gif')
}
onMounted(() => {
loadBoards()
})
</script>
<style scoped>
.board-environment-list {
margin: 2rem 0;
}
/* Search and Filter Bar */
.filter-bar {
margin-bottom: 1.5rem;
display: flex;
flex-direction: column;
gap: 0.75rem;
}
.search-box {
position: relative;
display: flex;
align-items: center;
}
.search-icon {
position: absolute;
left: 12px;
color: var(--vp-c-text-2);
pointer-events: none;
}
.search-input {
width: 100%;
padding: 0.6rem 2.2rem 0.6rem 2.4rem;
border: 1px solid var(--vp-c-divider);
border-radius: 8px;
font-size: 0.9rem;
background: var(--vp-c-bg);
color: var(--vp-c-text-1);
transition: border-color 0.2s;
}
.search-input:focus {
outline: none;
border-color: var(--vp-c-brand-1);
box-shadow: 0 0 0 3px rgba(62, 175, 124, 0.15);
}
.search-input::placeholder {
color: var(--vp-c-text-3);
}
.search-clear {
position: absolute;
right: 8px;
background: none;
border: none;
cursor: pointer;
padding: 4px;
color: var(--vp-c-text-2);
border-radius: 50%;
display: flex;
align-items: center;
}
.search-clear:hover {
background: var(--vp-c-bg-soft);
}
.filter-groups {
display: flex;
flex-wrap: wrap;
gap: 1rem;
}
.filter-group {
display: flex;
align-items: center;
gap: 0.5rem;
}
.filter-group__label {
font-size: 0.8rem;
font-weight: 600;
color: var(--vp-c-text-2);
white-space: nowrap;
}
.filter-chips {
display: flex;
flex-wrap: wrap;
gap: 0.4rem;
}
.filter-chip {
background: var(--vp-c-bg-soft);
color: var(--vp-c-text-1);
border: 1px solid var(--vp-c-divider);
padding: 0.25rem 0.7rem;
border-radius: 16px;
font-size: 0.78rem;
font-weight: 500;
cursor: pointer;
transition: all 0.2s;
}
.filter-chip:hover {
border-color: var(--vp-c-brand-1);
color: var(--vp-c-brand-1);
}
.filter-chip--active {
background: var(--vp-c-brand-1);
color: #ffffff;
border-color: var(--vp-c-brand-1);
}
.filter-chip--active:hover {
color: #ffffff;
opacity: 0.9;
}
.filter-status {
display: flex;
align-items: center;
gap: 0.75rem;
font-size: 0.85rem;
color: var(--vp-c-text-2);
}
.filter-clear {
background: none;
border: none;
color: var(--vp-c-brand-1);
cursor: pointer;
font-size: 0.85rem;
font-weight: 500;
padding: 0;
}
.filter-clear:hover {
text-decoration: underline;
}
.no-results {
text-align: center;
padding: 3rem 1rem;
color: var(--vp-c-text-2);
}
.no-results p {
margin-bottom: 1rem;
}
/* Grid Layout */
.boards-grid {
display: grid;
grid-template-columns: repeat(3, 1fr);
gap: 1rem;
margin-top: 1.5rem;
}
/* Card Design */
.board-card {
background: var(--vp-c-bg);
border: 1px solid var(--vp-c-divider);
border-radius: 8px;
overflow: hidden;
cursor: pointer;
transition: all 0.3s ease;
display: flex;
flex-direction: column;
box-shadow: 0 2px 4px rgba(0, 0, 0, 0.05);
}
.board-card:hover {
transform: translateY(-4px);
box-shadow: 0 8px 16px rgba(0, 0, 0, 0.1);
border-color: var(--vp-c-brand-1);
}
/* Image Section */
.board-card__image {
background: var(--vp-c-bg-soft);
padding: 1.5rem;
display: flex;
align-items: center;
justify-content: center;
min-height: 120px;
border-bottom: 1px solid var(--vp-c-divider);
position: relative;
}
.popular-badge {
position: absolute;
top: 8px;
right: 8px;
background: #ff9800;
color: #ffffff;
font-size: 0.65rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: 0.05em;
padding: 0.2rem 0.5rem;
border-radius: 4px;
}
.board-card__image img {
max-width: 100px;
max-height: 100px;
object-fit: contain;
}
/* Content Section */
.board-card__content {
padding: 1.25rem;
flex: 1;
display: flex;
flex-direction: column;
gap: 0.75rem;
}
/* Header */
.board-card__header {
display: flex;
justify-content: space-between;
align-items: flex-start;
gap: 0.75rem;
margin-bottom: 0.25rem;
}
.board-card__title {
margin: 0;
font-size: 1rem;
font-weight: 600;
line-height: 1.4;
flex: 1;
}
.board-card__title code {
background: transparent;
color: var(--vp-c-brand-1);
font-size: 0.9em;
padding: 0;
font-weight: 600;
}
.board-card__chip {
background: var(--vp-c-bg-soft);
color: var(--vp-c-text-2);
padding: 0.3rem 0.8rem;
border-radius: 4px;
font-size: 0.75rem;
font-weight: 600;
white-space: nowrap;
flex-shrink: 0;
border: 1px solid var(--vp-c-divider);
}
/* Description */
.board-card__description {
margin: 0;
font-size: 0.9rem;
line-height: 1.5;
color: var(--vp-c-text-2);
}
/* Libraries Section */
.board-card__libraries {
margin-top: 0.5rem;
padding-top: 0.25rem;
border-top: 1px solid var(--vp-c-divider);
}
.modules-label-row {
display: flex;
align-items: center;
gap: 0.2em;
margin-bottom: 0.5rem;
}
.libraries-label {
font-size: 0.8rem;
font-weight: 600;
color: var(--vp-c-text-2);
display: inline-block;
}
.libraries-badges {
display: flex;
flex-wrap: wrap;
gap: 0.4rem;
}
.lib-badge {
display: inline-block;
background: var(--vp-c-bg-soft);
color: var(--vp-c-text-1);
padding: 0.2rem 0.6rem;
border-radius: 4px;
font-size: 0.75rem;
font-weight: 500;
border: 1px solid var(--vp-c-divider);
}
/* Action Footer */
.board-card__action {
padding-top: 0.75rem;
margin-top: 0.5rem;
border-top: 1px solid var(--vp-c-divider);
}
.action-text {
color: var(--vp-c-brand-1);
font-size: 0.85rem;
font-weight: 600;
display: flex;
align-items: center;
gap: 0.25rem;
}
.board-card:hover .action-text {
text-decoration: underline;
}
/* Loading Spinner */
.loading-spinner {
display: inline-block;
width: 16px;
height: 16px;
min-width: 16px;
border: 2px solid #cfd8dc;
border-top-color: var(--vp-c-brand-1);
border-radius: 50%;
animation: spin 0.8s linear infinite;
vertical-align: middle;
margin-right: 0.5rem;
}
@keyframes spin {
to {
transform: rotate(360deg);
}
}
/* Responsive */
@media (max-width: 768px) {
.filter-groups {
flex-direction: column;
gap: 0.5rem;
}
.filter-group {
flex-wrap: wrap;
}
.boards-grid {
grid-template-columns: 1fr;
}
.board-card__image {
min-height: 100px;
padding: 1rem;
}
.board-card__image img {
max-width: 80px;
max-height: 80px;
}
}
@media (max-width: 480px) {
.board-card__header {
flex-direction: column;
align-items: flex-start;
}
.board-card__chip {
align-self: flex-start;
}
}
/* Espansione animata per badge */
.expand-fade-enter-active, .expand-fade-leave-active {
transition: max-height 0.3s cubic-bezier(0.4, 0, 0.2, 1), opacity 0.3s;
}
.expand-fade-enter-from, .expand-fade-leave-to {
opacity: 0;
max-height: 0;
}
.expand-fade-enter-to, .expand-fade-leave-from {
opacity: 1;
max-height: 500px;
}
.expand-icon-btn {
display: inline-flex;
align-items: center;
justify-content: center;
background: none;
border: none;
color: var(--vp-c-brand-1);
cursor: pointer;
margin-top: 0.3em;
margin-left: 0.2em;
padding: 0.1em 0.2em;
border-radius: 50%;
transition: background 0.2s;
}
.expand-icon-btn:hover {
background: rgba(62, 175, 124, 0.08);
}
.expand-icon-btn svg {
transition: transform 0.25s cubic-bezier(0.4,0,0.2,1);
vertical-align: middle;
}
.expand-icon-btn svg.rotated {
transform: rotate(90deg);
}
</style>