@@ -5,10 +5,10 @@ TODO List
55|
66| In General:
77|
8+ | *) More Documentation and Getting Started Templates
9+ | *) More Examples (for all or most scripts and features)
810| *) Translations
911| https://github.com/dataformsjs/dataformsjs/blob/master/docs/i18n-translations.md
10- | *) More Examples (for all or most scripts and features)
11- | *) More Documentation
1212| *) More Unit Testing
1313| *) Additional Scripts and Features
1414|
@@ -60,6 +60,43 @@ TODO List
6060 'app:contentReady', etc
6161 - Currently the places demo and other demos provide good examples
6262 when viewing source code of the demo.
63+ - Create a markdown overview doc using Web Components
64+ - Will cover overview and details - similar to the JSX Loader doc:
65+ https://github.com/dataformsjs/dataformsjs/blob/master/docs/jsx-loader.md
66+ - Topics to cover:
67+ - SPA Routing
68+ - Using to download JSON Data and bind to other elements on screen
69+ - How data binding works
70+ - Web Component "Services" Concept
71+ Add a template for this in quick ref section on main site
72+ - How the polyfill works and reason it was created over other options
73+ - How to test the polyfill with modern browsers:
74+ Just use:
75+ <script src="../js/web-components/polyfill.js"></script>
76+ Instead of:
77+ <script nomodule src="../js/web-components/polyfill.js"></script>
78+ - Provide examples of how [polyfill.js].[getRootUrl()] works for documentation.
79+ - Or add a markdown doc for it
80+ - Here is an example of an defining a custom URL from the app:
81+ <script>
82+ window.dataformsjsUrl = 'http://127.0.0.1:8080/js/';
83+ window.dataformsjsMinFiles = false; // Optional (defaults to `true`)
84+ </script>
85+ <script nomodule src="../js/web-components/polyfill.js"></script>
86+ - By default the path will be determined from where [/web-components/polyfill.js] is defined:
87+ <script src="../js/web-components/polyfill.min.js"></script>
88+ [*.min.js] Framework files will be downloaded
89+ <script src="../js/web-components/polyfill.js"></script>
90+ Full [*.js] Framework files will be downloaded
91+ - Once a Web Component and Framework doc are created then both those docs
92+ along with jsxLoader and Readme could be added as a new "Documentation"
93+ page on the main site using the new <markdown-content> component
94+ - Create a Markdown Doc for the Main Framework
95+ - Instead of the current getting started templates consider having many rather than just a few
96+ with the current language translations. For example the current versions can be built and then
97+ new templates added as it makes sense. Have many more templates would make it much easier to
98+ use DataFormsJS.
99+ https://www.dataformsjs.com/en/getting-started
63100 - Publish a nice looking version and more useful of markdown
64101 demos in the examples section of the main site.
65102 - Current Demos used for Development:
@@ -95,44 +132,45 @@ TODO List
95132 - Also likely another repository [create-dataformsjs-app] using
96133 [create-react-app] as a starter to show how to use DataFormsJS
97134 with [create-react-app].
98- - Create a markdown overview doc using Web Components
99- - Will cover overview and details - similar to the JSX Loader doc:
100- https://github.com/dataformsjs/dataformsjs/blob/master/docs/jsx-loader.md
101- - Topics to cover:
102- - SPA Routing
103- - Using to download JSON Data and bind to other elements on screen
104- - How data binding works
105- - Web Component "Services" Concept
106- Add a template for this in quick ref section on main site
107- - How the polyfill works and reason it was created over other options
108- - How to test the polyfill with modern browsers:
109- Just use:
110- <script src="../js/web-components/polyfill.js"></script>
111- Instead of:
112- <script nomodule src="../js/web-components/polyfill.js"></script>
113- - Provide examples of how [polyfill.js].[getRootUrl()] works for documentation.
114- - Or add a markdown doc for it
115- - Here is an example of an defining a custom URL from the app:
116- <script>
117- window.dataformsjsUrl = 'http://127.0.0.1:8080/js/';
118- window.dataformsjsMinFiles = false; // Optional (defaults to `true`)
119- </script>
120- <script nomodule src="../js/web-components/polyfill.js"></script>
121- - By default the path will be determined from where [/web-components/polyfill.js] is defined:
122- <script src="../js/web-components/polyfill.min.js"></script>
123- [*.min.js] Framework files will be downloaded
124- <script src="../js/web-components/polyfill.js"></script>
125- Full [*.js] Framework files will be downloaded
126- - Once a Web Component and Framework doc are created then both those docs
127- along with jsxLoader and Readme could be added as a new "Documentation"
128- page on the main site using the new <markdown-content> component
129135 - Log Demos:
130136 - https://www.dataformsjs.com/examples/log-table-vue.htm#/10
131137 * And other similar files
132138 - Log Demos should include a new [Info] tab with helpful text on what the demo shows.
133139 - The new [log-table-web-services.htm] should also link to [log-table-web.htm] and vice-versa.
134140
135141*) Web Components Updates
142+ - <data-list> and <data-table>
143+ - Include <url-router>.currentUrlParams in template rendering as `urlParams`
144+ - This would simply code below that uses `document.querySelector(...)` within the <template>
145+ <url-route path=":name">
146+ <template>
147+ <h1 url-param="name"></h1>
148+ <json-data
149+ url="/api/files/image-folder/:name" url-params>
150+ <is-loading>
151+ <span class="loading">Loading...</span>
152+ </is-loading>
153+ <has-error>
154+ <span class="error" data-bind="errorMessage"></span>
155+ </has-error>
156+ <is-loaded>
157+ <data-list
158+ data-bind="images"
159+ template-selector="#image"
160+ root-element="ul"
161+ list-item-name="image">
162+ </data-list>
163+ </is-loaded>
164+ </json-data>
165+ </template>
166+ </url-route>
167+ <template id="image">
168+ <li>
169+ <image-gallery image="/images/${document.querySelector('url-router').currentUrlParams.name}/${image}">
170+ <img src="/images/${document.querySelector('url-router').currentUrlParams.folder}/${image}" alt="${image}">
171+ <image-gallery>
172+ </li>
173+ </template>
136174 - Create a [custom-elements.json]
137175 - This format is not finalized so creating the file can wait till later
138176 https://runem.github.io/web-component-analyzer/
0 commit comments