save file

Author: javascript-2020

html-components/list/template/readme.md

@@ -1,158 +1,113 @@
-## Description
-
-The file-mod manages file access
-
-
-## Include
-
-requires component v3.0
-
-```
-
-      <file-mod component></file-mod>
-      
-```
-
-## initmod
-
-
-name      | description
-----------|------------
-ext       |       helper loader library
-$         |       various dom helper functions
-menumod   |       the menumod library
- |
-menu      |       reference to the menu to add its menu's to
-source    |       the source text
-focus     |       function to reset focus
-log       |       reference to log-mod component
- |
-complete  |       handles loading ( complete.load ) and saving ( complete.save )
-
-
-## attribute
-
-these attribute can be defined on the html tag itself
-
-attribute     | description
----------     |-----------
-none | no supported attributes
-
-
-## module
 
 
-name|description
----|---
-**standard** |
-initmod|standard function for importing local dependencies
-init|standard initialisation function
-initdom|standard function to setup the dom
- | 
-save ( file )   | read source blob and save under *file* or current file
-clear ()        | clear the current file
-new ( ...opts )   | alias for newfile
-[newfile](#file-descriptor) ( ...opts )   | create a new file desciptor object
-export ( file )   | serialise *file*
-import ( file )   | deserialise *file*
-test()|display test data
-
-
-
-<!--
-
-### doThing(input, [options], ...extras)
-
-Performs the main operation.
+## Description
 
-#### Parameters
-- **input** — string or object to process  
-- **[options]** — optional settings  
-  - **[options.mode="fast"]** — processing mode  
-  - **[options.verbose=false]** — enable verbose output  
-- **...extras** — additional values appended to the operation
+<div class=desc-txt>
 
-#### Returns
-- **Promise<Result>**
+The web-editor component produces an editor in the webpage
 
-#### Result
-- **success** — boolean indicating whether the operation succeeded  
-- **value** — the processed output  
-- **warnings** — array of strings describing non‑fatal issues  
-- **durationMs** — number of milliseconds the operation took  
+A modern, feature‑rich text editor built directly into the browser, this component is designed to make writing and editing feel effortless. Whether you’re building documentation tools, note‑taking apps, or custom content interfaces, it provides a smooth, polished experience that fits naturally into any webpage. Its clean interface keeps the focus on the text, while thoughtful details make everyday editing tasks quicker and more intuitive.
 
-#### Errors
-The promise rejects with:
-- **TypeError** — thrown when `input` is missing or invalid  
-- **OperationError** — thrown when processing fails internally  
-- **TimeoutError** — thrown when the operation takes too long
+Under the hood, the editor offers a flexible architecture that adapts to a wide range of use cases. It supports rich formatting, keyboard shortcuts, custom styling, and extensible behaviours, giving developers the freedom to tailor the writing environment to their needs. Despite its capabilities, it remains lightweight and responsive, ensuring fast load times and a fluid typing experience even in complex layouts.
 
--->
+This component is built with usability in mind, making it just as comfortable for casual writing as it is for more structured content creation. Whether you’re embedding it in a small widget or using it as the core of a larger application, it provides a dependable, modern editing foundation that feels right at home on the web.
 
+</div>
 
-## api
 
+--- {.hr-main}
 
-### save ( file )
+## Include
 
-reads a blob from source and saves it according to the file descriptor, then calls complete.save( file )
+```
 
+      <web-editor component></web-editor>
+      
+```
 
-### clear ( )
 
-clear the current file.  file-mod maintains a reference to the current file so that save can be called
-externally, ie say ctrl-s
+--- {.hr-main}
 
+## initmod
 
-### new ()
 
-alias for newfile
+name      | description
+----------|------------
+ext       | reference to ext-loader
+$         | reference to $ library
+ace       | reference to ace editor, else each instance of snippet-console loads its own
+menu      | reference to the menu group snippet-console should use, else it creates its own
+menumod   | reference to menumod library, only required if menu is not given
+config    | config parameters, see below
+fullsize  | true|false whether the editor should display the entire document
+kd        | callback for keydown event
+on        | callback for various events, see below
+mode      | the mode for the editor, javascript,css,html etc
+embed     | a dom node that the component will take its attributes from
 
 
-<div id=file-descriptor style='scroll-margin-top: 80px'>
+#### config
 
-### newfile ({filetype,path,name,rel,kind,size,ctime,mtime,atime,title,icon})
+config.mode    - set the mode for the editor, javascript,css,html,python etc
 
-</div>
+config.fullsize - true|false whether the editor should display the entire document
 
-create a file descriptor object
+config.height - set the height of the editor
 
-#### Parameters
 
-- **filetype || ft** = the filetype ( localfile,github,googlestorage ... )
+#### on
 
-- **abs**     = the absolute path of the file
+on.change - callback when the editor has a change event
 
-- **path**    = path of the file
 
-- **name**    = the name of the file
+--- {.hr-main}
 
-- **rel**     = relative path for the file, should this be relevant
+## attribute
 
-- **kind**    = kind of file structure this file object represents ( file,directory )
 
-- **size**    = the size of the file in bytes
 
-- **ctime**   = the create time of the file 
+these attribute can be defined on the html tag itself
 
-- **mtime**   = the modified time of the file
+attribute     | description
+---------     |-----------
+src         | src url to load 
+h \|\| height    | set the height of the editor
+mode        | set the mode for the editor
+fullsize    | boolean attribute, whether the editor display the entire document
 
-- **atime**   = the last access time of the file
 
-- **title**   = the title for the file
+--- {.hr-main}
 
-- **icon**    = an icon for the file
+## module
 
-#### Returns
+name|description
+---|---
+**standard** |
+initmod   | standard function for importing local dependencies
+init      | standard initialisation function
+initdom   | standard function to setup the dom
+ | 
+filename ( file )    | set the filename that the editor display, also sets the mode
+filename.getname ( path )    | helper function to return the filename from a path
+filename.save ( status ) | show or hide the save status icon
+filename.save.show () | show the save status icon
+filename.save.hide () | hide the save status icon
+filename.clear () | clear the filename
+filename.read () | read the current filename
+clear () | clear the editor
+set \|\| setvalue \|\| setValue ( txt ) | set the text of the editor
+get \|\| getvalue \|\| getValue () | get the text of the editor
+focus () | set focus to the editor
+resize () | update the editor dimensions ( width / height )
+load ( src ) |
+horiz () | set the editor to horizontal mode
+vert () | set the editor to vertical mode
+height | setter to set the height of the editor
+mode | getter / setter to get and set the mode of the editor
 
-- **Object** — the file descriptor
 
-#### Errors
-- **none**
 
-### export ( [file] )
 
-serialise and return file or the current file