README.md
1# JS UI Framework<a name="EN-US_TOPIC_0000001076213364"></a>
2
3- [Introduction](#section15701932113019)
4- [Directory Structure](#section1791423143211)
5- [When to Use](#section171384529150)
6- [Available Components](#section271831717166)
7- [Repositories Involved](#section1447164910172)
8
9## Introduction<a name="section15701932113019"></a>
10
11The OpenHarmony JS UI framework provides basic, container, and canvas UI components and standard CSS animation capabilities. It supports the web-development-like programming paradigm.
12
13- **Web-development-like paradigm**
14
15 The JS UI framework supports languages that are similar to those for web development, such as HTML and CSS. You can use them to describe the page layout and style, and use JavaScript \(conforming to the ECMAScript specification\) for page behavior. This paradigm allows you to avoid code for UI state switching. The view configuration information is intuitive.
16
17
18**Figure 1** Framework architecture<a name="fig2606133765017"></a>
19
20
21The JS UI framework consists of the application, framework, engine, and porting layers.
22
23- **Application**
24
25 Contains apps with Feature Abilities \(FAs\) developed with the JS UI framework. The FA app in this document refers to the app with FAs developed using JavaScript.
26
27- **Framework**
28
29 Parses UI pages and provides the Model-View-ViewModel \(MVVM\), page routing, custom components and more for front end development.
30
31- **Engine**
32
33 Accomplishes animation parsing, Document Object Model \(DOM\) building, layout computing, rendering command building and drawing, and event management.
34
35- **Porting Layer**
36
37 Abstracts the platform layer to provide abstract interfaces to connect to the platform. For example, event interconnection, rendering pipeline interconnection, and lifecycle interconnection.
38
39
40## Directory Structure<a name="section1791423143211"></a>
41
42The source code of the framework is stored in **/foundation/arkui/ace\_engine**. The following shows the directory structure.
43
44```
45/foundation/arkui/ace_engine
46├── adapter # Platform adaptation code
47│ ├── common
48│ └── ohos
49├── frameworks # Framework code
50│ ├── base # Basic libraries
51│ ├── bridge # Bridging layer for frontend and backend components
52│ └── core # Core components
53```
54
55## When to Use<a name="section171384529150"></a>
56
57JS UI framework provides various UI components with rich functionalities and style definitions. You can use and reuse any component anywhere as needed. You can customize new components by combining existing ones to simplify development.
58
59## Available Components<a name="section271831717166"></a>
60
61**Table 1** Components provided by the framework
62
63<a name="table2347172925617"></a>
64<table><thead align="left"><tr id="row5347429155610"><th class="cellrowborder" valign="top" width="28.64%" id="mcps1.2.3.1.1"><p id="p1347102910567"><a name="p1347102910567"></a><a name="p1347102910567"></a>Type</p>
65</th>
66<th class="cellrowborder" valign="top" width="71.36%" id="mcps1.2.3.1.2"><p id="p83475294565"><a name="p83475294565"></a><a name="p83475294565"></a>Components</p>
67</th>
68</tr>
69</thead>
70<tbody><tr id="row15347122918562"><td class="cellrowborder" valign="top" width="28.64%" headers="mcps1.2.3.1.1 "><p id="p679795614335"><a name="p679795614335"></a><a name="p679795614335"></a>Basic</p>
71</td>
72<td class="cellrowborder" valign="top" width="71.36%" headers="mcps1.2.3.1.2 "><p id="p88813982011"><a name="p88813982011"></a><a name="p88813982011"></a>button, text, input, label, image, progress, rating, span, marquee, image-animator, divider, menu, chart, option, picker, picker-view, piece, qrcode, select, slider, switch, toolbar, toolbar-item, toggle</p>
73</td>
74</tr>
75<tr id="row1973535793115"><td class="cellrowborder" valign="top" width="28.64%" headers="mcps1.2.3.1.1 "><p id="p8735195713313"><a name="p8735195713313"></a><a name="p8735195713313"></a>Container</p>
76</td>
77<td class="cellrowborder" valign="top" width="71.36%" headers="mcps1.2.3.1.2 "><p id="p1268024618208"><a name="p1268024618208"></a><a name="p1268024618208"></a>div, list, list-item, list-item-group, stack, swiper, tabs, tab-bar, tab-content, refresh, dialog, badge, panel, popup, stepper, stepper-item</p>
78</td>
79</tr>
80<tr id="row1792218915320"><td class="cellrowborder" valign="top" width="28.64%" headers="mcps1.2.3.1.1 "><p id="p692289163220"><a name="p692289163220"></a><a name="p692289163220"></a>Canvas</p>
81</td>
82<td class="cellrowborder" valign="top" width="71.36%" headers="mcps1.2.3.1.2 "><p id="p199228910327"><a name="p199228910327"></a><a name="p199228910327"></a>canvas</p>
83</td>
84</tr>
85<tr id="row837615526208"><td class="cellrowborder" valign="top" width="28.64%" headers="mcps1.2.3.1.1 "><p id="p4377752152016"><a name="p4377752152016"></a><a name="p4377752152016"></a>Grid</p>
86</td>
87<td class="cellrowborder" valign="top" width="71.36%" headers="mcps1.2.3.1.2 "><p id="p17377185222019"><a name="p17377185222019"></a><a name="p17377185222019"></a>grid-container, grid-row, grid-col</p>
88</td>
89</tr>
90</tbody>
91</table>
92
93## Repositories Involved<a name="section1447164910172"></a>
94
95JS UI framework
96
97**arkui\_ace\_engine**
98
99ace\_engine\_lite
100
101arkui\_napi
102
103
