added comments and platform check

Author: heckmon

CHANGELOG.md

@@ -1,3 +1,6 @@
 ## 0.0.1
 
 * Initial release
+
+## 0.0.2
+* Added KisWeb to detect and prevent webapps

README.md

@@ -6,10 +6,23 @@ A Flutter package to view directories and files in a foldable tree structure. Th
 
 - **Folder and File Tree Structure**: Display files and folders in a nested tree layout.
 - **Foldable Directories**: Allow users to expand and collapse directories.
-- **Custom Icons**: Easily customize folder and file icons.
+- **Custom Icons**: Easily customize foldaer and file icons.
 - **Custom Text Styles**: Style folder and file names using `TextStyle`.
 - **File Tap Handler**: Handle file taps to perform custom actions.
 
+| Platform   | Supported  |
+|------------|------------|
+| **Android** | ✓          |
+| **iOS**     | ✓          |
+| **Windows** | ✓          |
+| **Linux**   | ✓          |
+| **macOS**   | ✓          |
+| **Web**     | ✘          |
+
+_Note_: This package is not currently compatible with Web. 
+
+<br>
+
 <img src="https://i.imgur.com/CIw6251.gif" alt="gif" width="210" height="390" style="padding-right:45px"/>
 <img src = "https://i.imgur.com/dKUlq8v.gif" alt="gif" width="210" height="390"/>
 

doc/api/file_tree_view/DirectoryTreeStateNotifier-class.html

@@ -61,6 +61,9 @@ <h1><span class="kind-class">DirectoryTreeStateNotifier</span> class
 </h1></div>
 
 
+<section class="desc markdown">
+  <p>A notifier to manage the state of folded or unfolded directories.</p>
+</section>
 
 
     <section>
@@ -185,7 +188,7 @@ <h2>Methods</h2>
 
 </dt>
 <dd>
-  
+  Returns true if the directory is unfolded, otherwise false.
 
 
 </dd>
@@ -238,7 +241,7 @@ <h2>Methods</h2>
 
 </dt>
 <dd>
-  
+  Toggles the fold state of the directory.
 
 
 </dd>

doc/api/file_tree_view/DirectoryTreeStateNotifier/isUnfolded.html

@@ -71,6 +71,9 @@ <h1><span class="kind-method">isUnfolded</span> method
 
     </section>
 
+<section class="desc markdown">
+  <p>Returns true if the directory is unfolded, otherwise false.</p>
+</section>
 
 
 

doc/api/file_tree_view/DirectoryTreeStateNotifier/toggleFolder.html

@@ -71,6 +71,9 @@ <h1><span class="kind-method">toggleFolder</span> method
 
     </section>
 
+<section class="desc markdown">
+  <p>Toggles the fold state of the directory.</p>
+</section>
 
 
 

doc/api/file_tree_view/DirectoryTreeStateProvider-class.html

@@ -61,6 +61,9 @@ <h1><span class="kind-class">DirectoryTreeStateProvider</span> class
 </h1></div>
 
 
+<section class="desc markdown">
+  <p>A provider that supplies <a href="../file_tree_view/DirectoryTreeStateNotifier-class.html">DirectoryTreeStateNotifier</a> to its descendants in the widget tree.</p>
+</section>
 
 
     <section>
@@ -99,7 +102,7 @@ <h2>Constructors</h2>
           <span class="name"><a href="../file_tree_view/DirectoryTreeStateProvider/DirectoryTreeStateProvider.html">DirectoryTreeStateProvider</a></span><span class="signature">({<span class="parameter" id="-param-key"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/foundation/Key-class.html">Key</a>?</span> <span class="parameter-name">key</span>, </span><span class="parameter" id="-param-notifier"><span>required</span> <span class="type-annotation"><a href="../file_tree_view/DirectoryTreeStateNotifier-class.html">DirectoryTreeStateNotifier</a></span> <span class="parameter-name">notifier</span>, </span><span class="parameter" id="-param-child"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/widgets/Widget-class.html">Widget</a></span> <span class="parameter-name">child</span></span>})</span>
         </dt>
         <dd>
-          
+          Constructs a <a href="../file_tree_view/DirectoryTreeStateProvider-class.html">DirectoryTreeStateProvider</a> with the given notifier and child widget.
             <div class="constructor-modifier features">const</div>
         </dd>
     </dl>
@@ -346,7 +349,7 @@ <h2>Static Methods</h2>
 
 </dt>
 <dd>
-  
+  Accesses the <a href="../file_tree_view/DirectoryTreeStateNotifier-class.html">DirectoryTreeStateNotifier</a> in the widget tree.
 
 
 </dd>

doc/api/file_tree_view/DirectoryTreeStateProvider/DirectoryTreeStateProvider.html

@@ -69,6 +69,9 @@ <h1><span class="kind-constructor">DirectoryTreeStateProvider</span> constructor
     </section>
 
 
+<section class="desc markdown">
+  <p>Constructs a <a href="../../file_tree_view/DirectoryTreeStateProvider-class.html">DirectoryTreeStateProvider</a> with the given notifier and child widget.</p>
+</section>
 
 
 

doc/api/file_tree_view/DirectoryTreeStateProvider/of.html

@@ -71,6 +71,9 @@ <h1><span class="kind-method">of</span> static method
 
     </section>
 
+<section class="desc markdown">
+  <p>Accesses the <a href="../../file_tree_view/DirectoryTreeStateNotifier-class.html">DirectoryTreeStateNotifier</a> in the widget tree.</p>
+</section>
 
 
 

doc/api/file_tree_view/DirectoryTreeViewer-class.html

@@ -61,6 +61,9 @@ <h1><span class="kind-class">DirectoryTreeViewer</span> class
 </h1></div>
 
 
+<section class="desc markdown">
+  <p>A widget to display a directory tree structure with foldable directories and customizable file/folder icons and text styles.</p>
+</section>
 
 
     <section>
@@ -97,7 +100,7 @@ <h2>Constructors</h2>
           <span class="name"><a href="../file_tree_view/DirectoryTreeViewer/DirectoryTreeViewer.html">DirectoryTreeViewer</a></span><span class="signature">({<span class="parameter" id="-param-key"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/foundation/Key-class.html">Key</a>?</span> <span class="parameter-name">key</span>, </span><span class="parameter" id="-param-rootPath"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">rootPath</span>, </span><span class="parameter" id="-param-onFileTap"><span class="type-annotation">void</span> <span class="parameter-name">onFileTap</span>(<span class="parameter" id="param-"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-io/File-class.html">File</a></span></span>)?, </span><span class="parameter" id="-param-folderClosedicon"><span class="type-annotation">dynamic</span> <span class="parameter-name">folderClosedicon</span> = <span class="default-value">const Icon(Icons.folder)</span>, </span><span class="parameter" id="-param-folderOpenedicon"><span class="type-annotation">dynamic</span> <span class="parameter-name">folderOpenedicon</span> = <span class="default-value">const Icon(Icons.folder_open)</span>, </span><span class="parameter" id="-param-fileIcon"><span class="type-annotation">dynamic</span> <span class="parameter-name">fileIcon</span> = <span class="default-value">const Icon(Icons.insert_drive_file)</span>, </span><span class="parameter" id="-param-folderNameStyle"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/painting/TextStyle-class.html">TextStyle</a></span> <span class="parameter-name">folderNameStyle</span> = <span class="default-value">const TextStyle()</span>, </span><span class="parameter" id="-param-fileNameStyle"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/painting/TextStyle-class.html">TextStyle</a></span> <span class="parameter-name">fileNameStyle</span> = <span class="default-value">const TextStyle()</span>, </span><span class="parameter" id="-param-fileIconBuilder"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/widgets/Widget-class.html">Widget</a></span> <span class="parameter-name">fileIconBuilder</span>(<span class="parameter" id="param-fileExtension"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">fileExtension</span></span>)?</span>})</span>
         </dt>
         <dd>
-          
+          Constructs a <a href="../file_tree_view/DirectoryTreeViewer-class.html">DirectoryTreeViewer</a> with the given properties.
             <div class="constructor-modifier features">const</div>
         </dd>
     </dl>
@@ -115,7 +118,7 @@ <h2>Properties</h2>
 
 </dt>
 <dd>
-  
+  The icon for files. Default is a generic file icon.
   <div class="features"><span class="feature">final</span></div>
 
 </dd>
@@ -127,7 +130,7 @@ <h2>Properties</h2>
 
 </dt>
 <dd>
-  
+  A function that returns a custom file icon based on the file extension.
   <div class="features"><span class="feature">final</span></div>
 
 </dd>
@@ -139,7 +142,7 @@ <h2>Properties</h2>
 
 </dt>
 <dd>
-  
+  The text style for file names. Default is an empty <a href="https://api.flutter.dev/flutter/painting/TextStyle-class.html">TextStyle</a>.
   <div class="features"><span class="feature">final</span></div>
 
 </dd>
@@ -151,7 +154,7 @@ <h2>Properties</h2>
 
 </dt>
 <dd>
-  
+  The icon for closed folders. Default is a folder icon.
   <div class="features"><span class="feature">final</span></div>
 
 </dd>
@@ -163,7 +166,7 @@ <h2>Properties</h2>
 
 </dt>
 <dd>
-  
+  The text style for folder names. Default is an empty <a href="https://api.flutter.dev/flutter/painting/TextStyle-class.html">TextStyle</a>.
   <div class="features"><span class="feature">final</span></div>
 
 </dd>
@@ -175,7 +178,7 @@ <h2>Properties</h2>
 
 </dt>
 <dd>
-  
+  The icon for opened folders. Default is a folder opened icon.
   <div class="features"><span class="feature">final</span></div>
 
 </dd>
@@ -211,7 +214,7 @@ <h2>Properties</h2>
 
 </dt>
 <dd>
-  
+  Callback function when a file is tapped. Accepts a <a href="https://api.flutter.dev/flutter/dart-io/File-class.html">File</a> as parameter.
   <div class="features"><span class="feature">final</span></div>
 
 </dd>
@@ -223,7 +226,7 @@ <h2>Properties</h2>
 
 </dt>
 <dd>
-  
+  The root path of the directory to display.
   <div class="features"><span class="feature">final</span></div>
 
 </dd>

doc/api/file_tree_view/DirectoryTreeViewer/DirectoryTreeViewer.html

@@ -77,22 +77,25 @@ <h1><span class="kind-constructor">DirectoryTreeViewer</span> constructor
     </section>
 
 
+<section class="desc markdown">
+  <p>Constructs a <a href="../../file_tree_view/DirectoryTreeViewer-class.html">DirectoryTreeViewer</a> with the given properties.</p>
+</section>
 
 
 
 <section class="summary source-code" id="source">
   <h2><span>Implementation</span></h2>
-  <pre class="language-dart"><code class="language-dart">const DirectoryTreeViewer(
-    {super.key,
-    required this.rootPath,
-    this.onFileTap,
-    this.folderClosedicon = const Icon(Icons.folder),
-    this.folderOpenedicon = const Icon(Icons.folder_open,),
-    this.fileIcon = const Icon(Icons.insert_drive_file),
-    this.folderNameStyle=const TextStyle(),
-    this.fileNameStyle=const TextStyle(),
-    this.fileIconBuilder
-    });</code></pre>
+  <pre class="language-dart"><code class="language-dart">const DirectoryTreeViewer({
+  super.key,
+  required this.rootPath,
+  this.onFileTap,
+  this.folderClosedicon = const Icon(Icons.folder),
+  this.folderOpenedicon = const Icon(Icons.folder_open),
+  this.fileIcon = const Icon(Icons.insert_drive_file),
+  this.folderNameStyle = const TextStyle(),
+  this.fileNameStyle = const TextStyle(),
+  this.fileIconBuilder,
+});</code></pre>
 </section>