docs: ui,packages,lua (12 files)

This commit is contained in:
Richard Ward
2025-12-30 13:33:23 +00:00
parent 975b6dd7e6
commit e491364545
12 changed files with 59 additions and 33 deletions

View File

@@ -103,7 +103,7 @@
"@github/spark": ">=0.43.1 <1", // ⚠️ Evaluate - What is this?
```
**Action Needed:** Verify @github/spark usage
**Action Needed:** Verify any remaining @github/spark runtime usage (useKV imports replaced with local hook).
### Error Handling & Notifications
```json
@@ -168,11 +168,11 @@
## Dependencies to Evaluate
### @github/spark
**Current Version:** >=0.43.1 <1
**Purpose:** Unknown - needs investigation
**Action:** Search codebase for usage
**Decision:** Keep or remove based on usage
### @github/spark
**Current Version:** >=0.43.1 <1
**Purpose:** Previously for `useKV` hook usage
**Action:** Runtime imports replaced with local `@/hooks/data/useKV`; remaining references are docs and a module override type stub
**Decision:** Candidate for removal once no other Spark features are needed
### @next/third-parties
**Current Version:** ^16.1.1

View File

@@ -0,0 +1,10 @@
import React from 'react'
import { Icon, IconProps } from './Icon'
export const UserCheck = (props: IconProps) => (
<Icon {...props}>
<circle cx="108" cy="100" r="60" />
<path d="M22.2 200c21.6-38.6 62.8-64 85.8-64s64.2 25.4 85.8 64" />
<path d="M168 144l20 20 36-36" />
</Icon>
)

View File

@@ -55,6 +55,7 @@ export { UserCircle } from './UserCircle'
export { UserPlus } from './UserPlus'
export { UserMinus } from './UserMinus'
export { UserX } from './UserX'
export { UserCheck } from './UserCheck'
export { Users } from './Users'
export { UserSwitch } from './UserSwitch'
export { IdCard } from './IdCard'

View File

@@ -25,6 +25,7 @@ export {
Search,
Settings,
User,
UserCheck,
Menu,
Eye,
EyeSlash,

View File

@@ -126,7 +126,7 @@ export function StatusIndicator({ user, status }: StatusIndicatorProps) {
```typescript
// src/components/organisms/CommentSection.tsx
import { useState } from 'react'
import { useKV } from '@github/spark/hooks'
import { useKV } from '@/hooks/data/useKV'
import { Button, Input } from '@/components/atoms'
import { ProfileCard } from '@/components/molecules'
@@ -271,7 +271,7 @@ export function FormField({ label, error, ...props }: FormFieldProps) {
### Pattern: Data List
```typescript
// Organism handling data fetching and display
import { useKV } from '@github/spark/hooks'
import { useKV } from '@/hooks/data/useKV'
import { Button } from '@/components/atoms'
import { Card } from '@/components/ui'

View File

@@ -1,8 +1,10 @@
-- Profile module facade
-- Re-exports all profile functions for backward compatibility
local render_module = require("profile.render")
local save_module = require("profile.save_profile")
-- Profile module facade
-- Re-exports all profile functions for backward compatibility
require("profile.types")
local render_module = require("profile.render")
local save_module = require("profile.save_profile")
---@class ProfileModule
---@field render fun(ctx: RenderContext): UIComponent

View File

@@ -1,14 +1,8 @@
-- Save profile form handler
---@class FormData
---@field email string
---@class ProfileResponse
---@field success boolean
---@field action string
---@field email string
local M = {}
-- Save profile form handler
require("profile.types")
local M = {}
---Processes profile form submission and returns response
---@param form FormData

View File

@@ -23,6 +23,11 @@
---@field onClick string
---@field variant? string
---@class IconProps
---@field name string
---@field size? "small"|"medium"|"large"|"inherit"
---@field className? string
---@class FormData
---@field email string Email from form input

View File

@@ -13,6 +13,7 @@
---@field deleteUser fun(userId: string): boolean
---@field editUser fun(userId: string, updates: ModerationUpdates): boolean
---@field banUser fun(userId: string, reason: string): boolean
---@type Moderation
local M = {}
-- Import all single-function modules

View File

@@ -58,7 +58,10 @@ local function render(ctx)
end
return {
type = "Stack",
props = { spacing = 4 },
props = {
---@type StackProps
spacing = 4
},
children = {
{
type = "Button",

View File

@@ -1,7 +1,12 @@
-- Tenants module facade
-- Re-exports all tenant management functions for backward compatibility
local M = {}
-- Tenants module facade
-- Re-exports all tenant management functions for backward compatibility
---@class TenantsModule
---@field tenant_list fun(): TenantListComponent
---@field tenant_card fun(tenant: TenantInfo): TenantCardComponent
---@field create_tenant_form fun(): FormComponent
---@type TenantsModule
local M = {}
M.tenant_list = require("tenants.tenant_list")
M.tenant_card = require("tenants.tenant_card")

View File

@@ -1,7 +1,11 @@
-- Transfer module facade
-- Re-exports all power transfer functions for backward compatibility
local M = {}
-- Transfer module facade
-- Re-exports all power transfer functions for backward compatibility
---@class TransferModule
---@field transfer_form fun(from_user: User, to_user: User): TransferFormComponent
---@field transfer_history fun(): TransferHistoryComponent
---@type TransferModule
local M = {}
M.transfer_form = require("transfer.transfer_form")
M.transfer_history = require("transfer.transfer_history")