@coffic/cosy-ui 0.3.69 → 0.4.5

package/dist/types/footer.ts

@@ -10,37 +10,134 @@ export interface Product {
 }
 
 export interface FooterProps {
-    siteName: string;
-    homeLink: string;
-    slogan: string;
+    /**
+     * 关于链接
+     */
+    aboutLink?: string;
+
+    /**
+     * 博客链接
+     */
+    blogLink?: string;
+
+    /**
+     * 职业链接
+     */
+    careersLink?: string;
+
+    /**
+     * 公司名称
+     */
     company: string;
+
+    /**
+     * 联系链接
+     */
+    contactLink?: string;
+
+    /**
+     * 版权信息
+     */
     copyright: string;
-    inspirationalSlogan: string;
+
+    /**
+     * 调试模式
+     */
     debug?: boolean;
+
+    /**
+     * 是否启用日志输出
+     * @default false
+     */
+    enableLogging?: boolean;
+
+    /**
+     * 常见问题链接
+     */
+    faqLink?: string;
+
+    /**
+     * 历史链接
+     */
+    historyLink?: string;
+
+    /**
+     * 首页链接
+     */
+    homeLink: string;
+
+    /**
+     * ICP备案号
+     */
     icp?: string;
+
+    /**
+     * 激励标语
+     */
+    inspirationalSlogan: string;
+
+    /**
+     * 语言代码，默认自动检测
+     */
+    lang?: string;
+
+    /**
+     * 徽标
+     */
     logo?: Logo;
-    products?: Product[];
-    aboutLink?: string;
-    contactLink?: string;
-    termsLink?: string;
+
+    /**
+     * 媒体链接
+     */
+    mediaLink?: string;
+
+    /**
+     * 新闻链接
+     */
+    newsLink?: string;
+
+    /**
+     * 合作伙伴链接
+     */
+    partnersLink?: string;
+
+    /**
+     * 隐私链接
+     */
     privacyLink?: string;
+
+    /**
+     * 产品
+     */
+    products?: Product[];
+
+    /**
+     * 站点名称
+     */
+    siteName: string;
+
+    /**
+     * 标语
+     */
+    slogan: string;
+
+    /**
+     * 社交链接
+     */
     socialLinks?: string[];
+
+    /**
+     * 团队链接
+     */
     teamLink?: string;
-    careersLink?: string;
-    newsLink?: string;
-    historyLink?: string;
-    partnersLink?: string;
-    blogLink?: string;
-    faqLink?: string;
-    mediaLink?: string;
-    techStackLink?: string;
+
     /**
-     * 语言代码，默认自动检测
+     * 技术栈链接
      */
-    lang?: string;
+    techStackLink?: string;
+
     /**
-     * 是否启用日志输出
-     * @default false
+     * 条款链接
      */
-    enableLogging?: boolean;
-} 
+    termsLink?: string;
+}

package/dist/types/header.ts

@@ -0,0 +1,70 @@
+export interface HeaderProps {
+    /**
+     * 基础路径，用于处理网站部署在二级目录的情况
+     * @default ""
+     */
+    basePath?: string;
+
+    /**
+     * 当前语言代码
+     */
+    currentLocale?: string;
+
+    /**
+     * 侧边栏是否默认展开
+     * @default false
+     */
+    defaultSidebarOpen?: boolean;
+
+    /**
+     * 导航栏高度
+     * @default "md"
+     */
+    height?: '3xs' | '2xs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+
+    /**
+     * 语言选项列表
+     */
+    languages?: Array<{ code: string; name: string }>;
+
+    /**
+     * Logo图片元数据
+     */
+    logo?: ImageMetadata;
+
+    /**
+     * Logo 链接地址
+     * @default "/"
+     */
+    logoHref?: string;
+
+    /**
+     * 导航菜单项
+     */
+    navItems?: Array<{
+        href: string;
+        label: string;
+        match: (path: string) => boolean;
+    }>;
+
+    /**
+     * 是否显示侧边栏切换按钮
+     * @default false
+     */
+    showSidebarToggle?: boolean;
+
+    /**
+     * 社交链接
+     */
+    socialLinks?: Array<{
+        name: string;
+        url: string;
+        icon: any;
+    }>;
+
+    /**
+     * 是否固定在顶部
+     * @default true
+     */
+    sticky?: boolean;
+}

package/dist/types/layout.ts

@@ -1,10 +1,71 @@
-export interface SidebarItem {
-    href: string;
-    text: string;
-    items?: SidebarItem[];
-}
-
-export interface SidebarSection {
-    title: string;
-    items: SidebarItem[];
-}
+import type { FooterProps } from "./footer";
+import type { HeaderProps } from "./header";
+import type { MainContentProps } from "./main";
+import type { MetaProps } from "./meta";
+import type { SidebarProps } from "./sidebar";
+
+export interface AppLayoutProps {
+    /**
+     * 是否显示侧边栏
+     * @default true
+     */
+    showSidebar?: boolean;
+
+    /**
+     * 是否显示页眉
+     * @default true
+     */
+    showHeader?: boolean;
+
+    /**
+     * 是否显示页脚
+     * @default true
+     */
+    showFooter?: boolean;
+
+    /**
+     * 自定义头部内容
+     */
+    head?: astroHTML.JSX.Element;
+
+    /**
+     * 自定义头部内容
+     */
+    headerConfig: HeaderProps;
+
+    /**
+     * 侧边栏配置
+     */
+    sidebarConfig: SidebarProps;
+
+    /**
+     * 主内容配置
+     */
+    mainContentConfig: MainContentProps;
+
+    /**
+     * 页面类名
+     */
+    class?: string;
+
+    /**
+     * 类名列表
+     */
+    'class:list'?: any;
+
+    /**
+     * 调试模式，显示各个部分的边框
+     * @default false
+     */
+    debug?: boolean;
+
+    /**
+     * 元数据配置
+     */
+    metaConfig: MetaProps;
+
+    /**
+     * 页脚相关配置
+     */
+    footerConfig: FooterProps;
+}

package/dist/types/main.ts

@@ -0,0 +1,69 @@
+export interface MainContentProps {
+    /**
+     * 容器大小
+     * @default "md"
+     */
+    size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'full';
+
+    /**
+     * 水平内边距（通过 Container 组件的 padding 属性设置）
+     * @default "md"
+     */
+    padding?: 'none' | 'sm' | 'md' | 'lg' | 'xl';
+
+    /**
+   * 布局方式
+   * @default 'column'
+   */
+    layout?: 'row' | 'column';
+
+    /**
+     * 当前语言
+     */
+    currentLocale?: string;
+
+    /**
+     * 垂直内边距
+     * @default "md"
+     */
+    verticalPadding?: 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl' | '5xl' | string;
+
+    /**
+     * 是否居中显示内容
+     * @default true
+     */
+    centered?: boolean;
+
+    /**
+     * 是否为文章布局
+     * @default false
+     */
+    isArticle?: boolean;
+
+    /**
+     * 是否显示目录
+     * @default false
+     */
+    showTableOfContents?: boolean;
+
+    /**
+     * 背景颜色
+     * @default undefined
+     */
+    backgroundColor?: 'primary' | 'secondary' | 'tertiary' | 'light' | 'dark' | string;
+
+    /**
+     * HTML id 属性
+     */
+    id?: string;
+
+    /**
+     * 类名
+     */
+    class?: string;
+
+    /**
+     * 类名列表
+     */
+    'class:list'?: any;
+}

package/dist/types/meta.ts

@@ -0,0 +1,50 @@
+export interface MetaProps {
+    title: string;
+    description: string;
+    keywords: string;
+    author: string;
+    robots: string;
+
+    /**
+     * 基础路径，用于处理网站部署在二级目录的情况
+     * @default ""
+     */
+    basePath?: string;
+
+    /**
+     * 站点名称
+     */
+    siteName?: string;
+
+    /**
+     * 页面语言
+     * @default "zh-CN"
+     */
+    lang?: string;
+
+    /**
+     * 是否包含视口元标签
+     * @default true
+     */
+    viewport?: boolean;
+
+    /**
+     * 自定义CSS
+     */
+    customStyles?: string;
+
+    /**
+     * 自定义头部内容
+     */
+    head?: astroHTML.JSX.Element;
+
+    /**
+     * 页面类名
+     */
+    class?: string;
+
+    /**
+     * 类名列表
+     */
+    'class:list'?: any;
+}

package/dist/types/sidebar.ts

@@ -0,0 +1,38 @@
+export interface SidebarItem {
+    href: string;
+    text: string;
+    items?: SidebarItem[];
+}
+
+export interface SidebarSection {
+    title: string;
+    items: SidebarItem[];
+}
+
+export interface SidebarProps {
+    /**
+     * 侧边栏项目
+     */
+    sidebarItems: SidebarSection[];
+
+    /**
+     * 桌面端类名
+     */
+    class?: string;
+
+    /**
+     * 是否开启调试模式，显示边框
+     * @default false
+     */
+    debug?: boolean;
+
+    /**
+     * 侧边栏顶部外边距
+     */
+    marginTop?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl' | '5xl' | string;
+
+    /**
+     * 侧边栏底部外边距
+     */
+    marginBottom?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl' | '5xl' | string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coffic/cosy-ui",
-    "version": "0.3.69",
+    "version": "0.4.5",
     "description": "An astro component library",
     "author": {
         "name": "nookery",
@@ -17,7 +17,7 @@
         "astro",
         "cosy-ui"
     ],
-    "homepage": "https://github.com/CofficLab/cosy-ui",
+    "homepage": "https://cofficlab.github.io/cosy-ui/en/",
     "publishConfig": {
         "access": "public"
     },

package/dist/components/layouts/DefaultLayout.astro

@@ -1,170 +0,0 @@
----
-/**
- * DefaultLayout组件
- * 
- * 包含常用页面结构的默认布局，包括简单的页眉和页脚
- * 
- * @example
- * ```astro
- * ---
- * import DefaultLayout from '../layouts/DefaultLayout.astro';
- * ---
- * 
- * <DefaultLayout title="页面标题" description="页面描述">
- *   <h1>页面内容</h1>
- *   <p>这是页面的主要内容</p>
- * </DefaultLayout>
- * ```
- */
-
-import BaseLayout from './BaseLayout.astro';
-import Link from '../base/Link.astro';
-
-// 导入样式
-import '../../app.css';
-
-export interface NavLink {
-  href: string;
-  label: string;
-}
-
-export interface Props {
-  /**
-   * 页面标题
-   */
-  title: string;
-  
-  /**
-   * 页面描述
-   */
-  description?: string;
-  
-  /**
-   * 页面关键词
-   */
-  keywords?: string;
-  
-  /**
-   * 是否显示页眉
-   * @default true
-   */
-  showHeader?: boolean;
-  
-  /**
-   * 是否显示页脚
-   * @default true
-   */
-  showFooter?: boolean;
-  
-  /**
-   * 网站名称
-   * @default "网站名称"
-   */
-  siteName?: string;
-  
-  /**
-   * 导航链接
-   */
-  navLinks?: NavLink[];
-  
-  /**
-   * 页面容器类名
-   */
-  containerClass?: string;
-  
-  /**
-   * 自定义头部内容
-   */
-  head?: astroHTML.JSX.Element;
-  
-  /**
-   * 页面类名
-   */
-  class?: string;
-  
-  /**
-   * 类名列表
-   */
-  'class:list'?: any;
-}
-
-const {
-  title,
-  description,
-  keywords,
-  showHeader = true,
-  showFooter = true,
-  siteName = "网站名称",
-  navLinks = [
-    { href: "/", label: "首页" },
-    { href: "/about", label: "关于" },
-    { href: "/contact", label: "联系我们" }
-  ],
-  containerClass = "container mx-auto px-4 py-8",
-  head,
-  class: className,
-  'class:list': classList,
-  ...rest
-} = Astro.props;
-
-const year = new Date().getFullYear();
----
-
-<BaseLayout 
-  title={title} 
-  description={description} 
-  keywords={keywords}
-  head={head}
-  class={className}
-  {...rest}
->
-  {showHeader && (
-    <header class="site-header">
-      <div class="container px-4 py-4">
-        <div class="header-content">
-          <div class="logo">
-            <a href="/" class="site-name">{siteName}</a>
-          </div>
-          
-          <nav class="main-nav">
-            <ul class="nav-list">
-              {navLinks.map((link: NavLink) => (
-                <li class="nav-item">
-                  <Link href={link.href} variant="text">{link.label}</Link>
-                </li>
-              ))}
-            </ul>
-          </nav>
-        </div>
-      </div>
-    </header>
-  )}
-  
-  <main class={containerClass}>
-    <slot />
-  </main>
-  
-  {showFooter && (
-    <footer class="site-footer">
-      <div class="container px-4 py-8">
-        <div class="footer-content">
-          <div class="footer-info">
-            <p class="copyright">&copy; {year} {siteName}. 保留所有权利。</p>
-          </div>
-          
-          <nav class="footer-nav">
-            <ul class="nav-list">
-              {navLinks.map((link: NavLink) => (
-                <li class="nav-item">
-                  <Link href={link.href} variant="text" size="sm">{link.label}</Link>
-                </li>
-              ))}
-            </ul>
-          </nav>
-        </div>
-      </div>
-    </footer>
-  )}
-  
-  <slot name="after-footer" />
-</BaseLayout>