save file

Author: javascript-2020

html-components/list/dir-tree/readme.md

@@ -1,13 +1,13 @@
 ## Description
 
-The web-console provides a console ( like dev tools ) in a webpage
+Produces a file listing in a webpage
 
 
 ## Include
 
 ```
 
-      <web-console component></web-console>
+      <dir-tree component></dir-trere>
       
 ```
 
@@ -16,11 +16,6 @@ The web-console provides a console ( like dev tools ) in a webpage
 
 name      | description
 ----------|------------
-$         |	the dom helper library
-ace       | a global reference to ace editor, otherwise each instance of the web-console will load its own ace editor, specifying this ensures its only loaded once
-embed     | allows reading the supported attributes from another node
-config    | config parameters, see below
-echo      | whether to echo the output to the dev tools console
 
 
 ## api
@@ -31,14 +26,10 @@ these attribute can be defined on the html tag itself
 
 attribute     | description
 ---------     |-----------
-fullsize      | the console will keep expanding to show all content
-h \| height   | sets the height of the console
 
 
 ### module
 
-methods without a description are not currently implmented and are passed through to dev tools
-
 
 name|description
 ---|---
@@ -47,33 +38,67 @@ initmod|standard function for importing local dependencies
 init|standard initialisation function
 initdom|standard function to setup the dom
  | 
-**console** | 
-assert|
-clear|clear the console
-count|
-countReset|
-debug|write debug information to the console
-dir|
-dirxml|
-error|display error information in the console
-group|
-groupCollapsed|
-groupEnd|
-info|
-log|log data to the console
-profile|
-profileEnd|
-table|
-time|
-timeEnd|
-timeLog|
-timeStamp|
-trace|
-warn|display warn information in the console
- | 
-**extended** | 
-write|write to the console, without adding a newline character at the end of the output
-json|write json stringified output to the console
- | 
- | 
-test|display test data in the console, for quick tests
+build(data)|takes a simple object structure and return a structure that dirtree can use ( see below )
+display(data,options)|display the directory structure
+clear|clear the directory tree
+find(path)|find the object representing the directory
+open(path)|expand the directory
+close(path)|collapse the directory
+test()|display test data
+
+
+### api
+
+
+#### build(data)
+
+takes a simple, easy to represent object structure representing a directory
+
+```
+
+      var data    = {
+            'tmp'   : {
+                  'tmp-1'   : {
+                        'test.txt':null,
+                  },
+                  'my-file-1.bin':null,
+                  'my-file-2.bin':null,
+            },
+            'hello-1.txt':null,
+            'hello-2.txt':null,
+      };
+
+```
+
+and produces a ibject structure that can be used by dir-tree to display the directory
+
+```
+
+              var data    = [
+                    {
+                          parent    : null,
+                          type      : 'dir',
+                          name      : 'tmp',
+                          list      : [
+                                {
+                                      parent    : {object},
+                                      type      : 'dir',
+                                      name      : 'tmp-1',
+                                      list      : [
+                                            {
+                                                  parent    : 'object',
+                                                  type      : 'file',
+                                                  name      : 'test.txt'
+                                            }
+                                      ]
+                                },
+                                {
+                                      parent    : {object},
+                                      type      : 'file',
+                                      name      : 'hello.txt'
+                                }
+                          ]
+                    }
+              ];
+
+```