소스 검색

[stdf]Add JSDoc

dufu1991 2 년 전
부모
커밋
b5dadac48b
3개의 변경된 파일63개의 추가작업 그리고 23개의 파일을 삭제
  1. 1 1
      demo/src/routes/en_US/navBar/+page.svelte
  2. 1 1
      demo/src/routes/zh_CN/navBar/+page.svelte
  3. 61 21
      packages/stdf/components/navBar/NavBar.svelte

+ 1 - 1
demo/src/routes/en_US/navBar/+page.svelte

@@ -33,7 +33,7 @@
 
 	<NavBar
 		title="There is no dividing line between the left side and the bottom, and the text is too long"
-		left=""
+		left="none"
 		line={false}
 		rights={icons3}
 	/>

+ 1 - 1
demo/src/routes/zh_CN/navBar/+page.svelte

@@ -32,7 +32,7 @@
 	/>
 	<Toast bind:visible={visible2} message={`点击的右侧图标索引值是 ${rightIndex}。`} />
 	<!-- 无底部分割线,文字过长 -->
-	<NavBar title="无左侧与底分割线,文字过长长长长长长长" left="" line={false} rights={icons3} />
+	<NavBar title="无左侧与底分割线,文字过长长长长长长长" left="none" line={false} rights={icons3} />
 	<!-- 自定义背景颜色 -->
 	<NavBar title="自定义背景颜色 by injClass" injClass="bg-[wheat] dark:bg-extend0" />
 	<!-- 自定义文字颜色 -->

+ 61 - 21
packages/stdf/components/navBar/NavBar.svelte

@@ -13,49 +13,89 @@
 	const navBarLang = currentLang.navBar;
 	const commonLang = currentLang.common;
 
-	// 标题
-	// Title
+	/**
+	 * 标题
+	 * Title
+	 * @type {string}
+	 * @default Current language navBar.title
+	 */
 	export let title = navBarLang.title;
 
-	//标题是否使用slot
-	//Whether to use slot for title
+	/**
+	 * 标题是否使用slot
+	 * Whether to use slot for title
+	 * @type {boolean}
+	 * @default false
+	 */
 	export let titleSlot = false;
 
-	//左侧图标
-	//Left icon
+	/**
+	 * 左侧图标
+	 * Left icon
+	 * @type {'back'|'customIcon'|'none'}
+	 * @default 'back'
+	 */
 	export let left = 'back';
 
-	//左侧图标参数
-	//Left icon parameters
+	/**
+	 * 左侧图标参数
+	 * Left icon parameters
+	 * @type {object}
+	 * @default {}
+	 */
 	export let leftIcon = {};
 
-	//左侧是否使用slot
-	//Whether to use slot for left
+	/**
+	 * 左侧是否使用slot
+	 * Whether to use slot for left
+	 * @type {boolean}
+	 * @default false
+	 */
 	export let leftSlot = false;
 
-	//右侧 Icon 数组
-	//Right Icon array
+	/**
+	 * 右侧 Icon 数组
+	 * Right Icon array
+	 * @type {object[]}
+	 * @default []
+	 */
 	export let rights = [];
 
-	//右侧是否使用slot
-	//Whether to use slot for right
+	/**
+	 * 右侧是否使用slot
+	 * Whether to use slot for right
+	 * @type {boolean}
+	 * @default false
+	 */
 	export let rightSlot = false;
 
-	//是否显示底部分割线
-	//Whether to show bottom line
+	/**
+	 * 是否显示底部分割线
+	 * Whether to show bottom line
+	 * @type {boolean}
+	 * @default true
+	 */
 	export let line = true;
 
-	//注入CSS
-	//Inject CSS
+	/**
+	 * 注入CSS
+	 * Inject CSS
+	 * @type {string}
+	 * @default ''
+	 */
 	export let injClass = '';
 
-	//是否开启关爱版
-	//Whether to open love version
+	/**
+	 * 是否开启关爱版
+	 * Whether to open love version
+	 * @type {boolean}
+	 * @default false
+	 */
 	export let love = false;
 
 	//图标大小
 	//Icon size
-	$: iconSize = love ? 30 : 24;
+	const iconSize = love ? 30 : 24;
 
 	//左侧图标点击事件
 	//Left icon click event