Files
catalog/readme.md

92 lines
2.9 KiB
Markdown
Raw Normal View History

2026-01-12 10:57:54 +00:00
# @ecobridge.xyz/catalog
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
A web component catalog for building ecobridge application interfaces. Built on top of `@design.estate/dees-catalog` and extending it with specialized components for the ecobridge ecosystem.
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
## Installation
2026-01-06 02:24:12 +00:00
```bash
2026-01-12 10:57:54 +00:00
pnpm add @ecobridge.xyz/catalog
2026-01-06 02:24:12 +00:00
```
2026-01-12 10:57:54 +00:00
## Components
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
### EcoApplauncher
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
The main application launcher component providing a complete desktop-like interface with:
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
- Login view with customizable authentication
- Home view with app grid
- Top bar with date, search, notifications, and user info
- Status bar with network, battery, sound, and keyboard indicators
- Power menu with shutdown, restart, sleep, and lock options
2026-01-06 02:24:12 +00:00
```typescript
2026-01-12 10:57:54 +00:00
import { EcoApplauncher } from '@ecobridge.xyz/catalog';
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
const launcher = document.createElement('eco-applauncher');
launcher.mode = 'login'; // or 'home'
launcher.apps = [
{ name: 'Settings', icon: 'lucide:settings', action: () => openSettings() },
{ name: 'Files', icon: 'lucide:folder', action: () => openFiles() },
];
document.body.appendChild(launcher);
2026-01-06 02:24:12 +00:00
```
2026-01-12 10:57:54 +00:00
### Sub-Components
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
| Component | Description |
|-----------|-------------|
| `EcoApplauncherWifimenu` | WiFi network selection menu |
| `EcoApplauncherBatterymenu` | Battery status and power mode menu |
| `EcoApplauncherSoundmenu` | Audio device and volume control menu |
| `EcoApplauncherKeyboard` | Virtual on-screen keyboard |
| `EcoApplauncherPowermenu` | Power actions menu (shutdown, restart, etc.) |
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
### EcoScreensaver
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
A subtle animated screensaver component with flowing geometric patterns.
2026-01-06 02:24:12 +00:00
```typescript
2026-01-12 10:57:54 +00:00
import { EcoScreensaver } from '@ecobridge.xyz/catalog';
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
// Show screensaver
await EcoScreensaver.show();
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
// Hide screensaver
EcoScreensaver.hide();
2026-01-06 02:24:12 +00:00
```
2026-01-12 10:57:54 +00:00
## Development
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
```bash
# Install dependencies
pnpm install
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
# Watch mode for development
pnpm run watch
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
# Build
pnpm run build
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
# Run tests
pnpm test
2026-01-06 02:24:12 +00:00
```
## License and Legal Information
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
2026-01-12 10:57:54 +00:00
This project is owned and maintained by Lossless GmbH. The names and logos associated with Lossless GmbH and any related products or services are trademarks of Lossless GmbH or third parties, and are not included within the scope of the MIT license granted herein.
2026-01-06 02:24:12 +00:00
### Company Information
2026-01-12 10:57:54 +00:00
Lossless GmbH
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
For any legal inquiries or further information, please contact us via the official channels.
2026-01-06 02:24:12 +00:00
2026-01-12 10:57:54 +00:00
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Lossless GmbH of any derivative works.