vvvfs 0.2.1 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.html CHANGED
@@ -10,6 +10,7 @@
10
10
 
11
11
  <body>
12
12
  <script src="index.js"></script>
13
+ <fs-img src="test.png" alt="Test Image"></fs-img>
13
14
  </body>
14
15
 
15
16
  </html>
package/index.ts CHANGED
@@ -4,6 +4,10 @@ import { Mime } from "mime";
4
4
  import standardTypes from "mime/types/standard.js";
5
5
  import otherTypes from "mime/types/other.js";
6
6
 
7
+ // 自定义元素 <fs-img> / <fs-audio> / <fs-video>(直接显示 / 播放 vvvfs 中的媒体文件)
8
+ export { FsImg } from "./Img";
9
+ export { FsAudio, FsVideo } from "./Media";
10
+
7
11
  const mime = new Mime(standardTypes, otherTypes);
8
12
 
9
13
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vvvfs",
3
- "version": "0.2.1",
3
+ "version": "0.2.3",
4
4
  "description": "一个使用IndexDB实现的虚拟文件系统",
5
5
  "keywords": [
6
6
  "Virtual",
package/types/index.d.ts CHANGED
@@ -608,6 +608,183 @@ export class VVVFS {
608
608
  static registerMIMEType(mimetype: string, extensions: string[]): Mime;
609
609
  }
610
610
 
611
+ /**
612
+ * <fs-img> / <fs-audio> / <fs-video> 元素 load 事件详情
613
+ */
614
+ export interface FsMediaLoadDetail {
615
+ /**
616
+ * 媒体文件路径
617
+ */
618
+ path: string;
619
+ /**
620
+ * 媒体文件对象
621
+ */
622
+ file: File | null;
623
+ }
624
+
625
+ /**
626
+ * <fs-img> / <fs-audio> / <fs-video> 元素 error 事件详情
627
+ */
628
+ export interface FsMediaErrorDetail {
629
+ /**
630
+ * 媒体文件路径
631
+ */
632
+ path: string;
633
+ /**
634
+ * 错误信息
635
+ */
636
+ message: string;
637
+ }
638
+
639
+ /**
640
+ * 自定义图片元素 <fs-img>
641
+ * @description 直接读取并显示存储在 vvvfs 中的图片文件
642
+ * @attributes
643
+ * - src / path:图片在 vvvfs 中的路径(src 优先,其次 path)
644
+ * - dbname:数据库名,默认 "vvvfs";未指定且存在全局 vvvfs 实例时直接使用该实例
645
+ * - alt / width / height:透传到内部 <img> 元素
646
+ * - watch:存在时,文件发生变化自动刷新
647
+ * @events
648
+ * - load:图片加载完成(detail: { path, file })
649
+ * - error:图片加载失败(detail: { path, message })
650
+ * @example <fs-img src="/home/user/Pictures/logo.png" alt="Logo" width="120"></fs-img>
651
+ */
652
+ export class FsImg extends HTMLElement {
653
+ /**
654
+ * 监听的属性列表
655
+ */
656
+ static get observedAttributes(): string[];
657
+ /**
658
+ * 构造函数
659
+ */
660
+ constructor();
661
+ /**
662
+ * 图片路径(src 优先,其次 path)
663
+ */
664
+ src: string;
665
+ /**
666
+ * 数据库名
667
+ */
668
+ dbname: string;
669
+ /**
670
+ * 是否监听文件变化(true 启用,false 停止)
671
+ */
672
+ watch: boolean;
673
+ /**
674
+ * 当前显示的图片文件对象(未加载或加载失败时为 null)
675
+ */
676
+ readonly data: Blob | null;
677
+ /**
678
+ * 手动刷新(重新读取并显示图片)
679
+ */
680
+ refresh(): Promise<boolean>;
681
+ /**
682
+ * 调度一次 watch 触发的刷新(内部使用)
683
+ * @internal
684
+ */
685
+ scheduleWatchRefresh(): void;
686
+ }
687
+
688
+ /**
689
+ * 自定义音频元素 <fs-audio>
690
+ * @description 直接读取并播放存储在 vvvfs 中的音频文件
691
+ * @attributes
692
+ * - src / path:音频在 vvvfs 中的路径(src 优先,其次 path)
693
+ * - dbname:数据库名,默认 "vvvfs";未指定且存在全局 vvvfs 实例时直接使用该实例
694
+ * - controls:是否显示控制条(默认显示)
695
+ * - autoplay / loop / muted / preload:透传到内部 <audio> 元素
696
+ * - watch:存在时,文件发生变化自动刷新
697
+ * @events
698
+ * - load:音频数据加载完成(detail: { path, file })
699
+ * - error:音频加载失败(detail: { path, message })
700
+ * @example <fs-audio src="/home/user/Music/demo.mp3"></fs-audio>
701
+ */
702
+ export class FsAudio extends HTMLElement {
703
+ /**
704
+ * 监听的属性列表
705
+ */
706
+ static get observedAttributes(): string[];
707
+ /**
708
+ * 构造函数
709
+ */
710
+ constructor();
711
+ /**
712
+ * 音频路径(src 优先,其次 path)
713
+ */
714
+ src: string;
715
+ /**
716
+ * 数据库名
717
+ */
718
+ dbname: string;
719
+ /**
720
+ * 是否监听文件变化(true 启用,false 停止)
721
+ */
722
+ watch: boolean;
723
+ /**
724
+ * 当前显示的音频文件对象(未加载或加载失败时为 null)
725
+ */
726
+ readonly data: Blob | null;
727
+ /**
728
+ * 手动刷新(重新读取并显示音频)
729
+ */
730
+ refresh(): Promise<boolean>;
731
+ /**
732
+ * 调度一次 watch 触发的刷新(内部使用)
733
+ * @internal
734
+ */
735
+ scheduleWatchRefresh(): void;
736
+ }
737
+
738
+ /**
739
+ * 自定义视频元素 <fs-video>
740
+ * @description 直接读取并播放存储在 vvvfs 中的视频文件
741
+ * @attributes
742
+ * - src / path:视频在 vvvfs 中的路径(src 优先,其次 path)
743
+ * - dbname:数据库名,默认 "vvvfs";未指定且存在全局 vvvfs 实例时直接使用该实例
744
+ * - controls:是否显示控制条(默认显示)
745
+ * - autoplay / loop / muted / preload / width / height:透传到内部 <video> 元素
746
+ * - watch:存在时,文件发生变化自动刷新
747
+ * @events
748
+ * - load:视频数据加载完成(detail: { path, file })
749
+ * - error:视频加载失败(detail: { path, message })
750
+ * @example <fs-video src="/home/user/Videos/demo.mp4" width="320"></fs-video>
751
+ */
752
+ export class FsVideo extends HTMLElement {
753
+ /**
754
+ * 监听的属性列表
755
+ */
756
+ static get observedAttributes(): string[];
757
+ /**
758
+ * 构造函数
759
+ */
760
+ constructor();
761
+ /**
762
+ * 视频路径(src 优先,其次 path)
763
+ */
764
+ src: string;
765
+ /**
766
+ * 数据库名
767
+ */
768
+ dbname: string;
769
+ /**
770
+ * 是否监听文件变化(true 启用,false 停止)
771
+ */
772
+ watch: boolean;
773
+ /**
774
+ * 当前显示的视频文件对象(未加载或加载失败时为 null)
775
+ */
776
+ readonly data: Blob | null;
777
+ /**
778
+ * 手动刷新(重新读取并显示视频)
779
+ */
780
+ refresh(): Promise<boolean>;
781
+ /**
782
+ * 调度一次 watch 触发的刷新(内部使用)
783
+ * @internal
784
+ */
785
+ scheduleWatchRefresh(): void;
786
+ }
787
+
611
788
  /**
612
789
  * 解析路径
613
790
  * @param path 路径