Skip to content

Commit 5989f4a

Browse files
committed
Add a "Known issues" section to the README
1 parent 4b36037 commit 5989f4a

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,16 @@ On Windows, you can wrap those commands in a BAT file.
6565
* nativescript-angular code
6666
* NativeScript typings: typings/nativescript
6767
3. All required JavaScript packages (including compiled NativeScript modules) are copied to `ng-sample/app/tns_modules`
68+
69+
# How the integration code works
70+
71+
1. Use the Angular Parse5DomAdapter to parse component markup.
72+
2. Provide a custom renderer (`NativeScriptRenderer`) that works with the parsed DOM and creates NativeScript UI elements. Only limited number of visual elements supported so far.
73+
74+
# Known issues
75+
76+
1. The renderer code needs to be cleaned up and made extensible, so that people can register new visual elements.
77+
2. There are certain issues with the Parse5DomAdapter and we'll likely need to provide our own later on:
78+
* Element and attribute names always get lowercased.
79+
* Self-closing elements (`<Label text="Name" /><Button text="Save" />`) get parsed wrong (in this case Button gets parsed as a Label child.
80+
3. The renderer implementation is by no means complete: we are still need to support view (de)hydration, DOM text updates, event dispatching, actions, etc.

0 commit comments

Comments
 (0)