@meursyphus/flitter 2.0.1 → 2.0.3

package/README.md

@@ -1,21 +1,22 @@
 # Flitter
 
-Flitter is a powerful framework inspired by Flutter, supporting both SVG and Canvas to create high-performance graphics and user interfaces. It is designed to easily implement complex data visualizations, interactive charts, diagrams, and graphic editors in web applications.
-
+Flitter is a powerful JavaScript rendering engine and framework inspired by Flutter, supporting both SVG and Canvas to create high-performance graphics and user interfaces. As a rendering engine, it provides fine-grained control over the rendering process, allowing developers to create complex, interactive visualizations with ease. It is designed to efficiently implement data visualizations, interactive charts, diagrams, and graphic editors in web applications.
 
 ## Key Features
 
-- **Render Object Tree**: Flitter uses a render object tree for efficient rendering, allowing easy management and manipulation of complex layouts.
+- **Advanced Rendering Engine**: At its core, Flitter is a sophisticated rendering engine that gives developers precise control over how elements are drawn and updated on the screen.
+
+- **Render Object Tree**: Flitter uses a render object tree for efficient rendering, allowing easy management and manipulation of complex layouts. This tree-based approach, central to Flitter's rendering engine, enables optimized updates and redraws.
 
-- **Declarative Programming**: Following a declarative paradigm, the screen automatically updates when values change, simplifying application state management.
+- **Declarative Programming**: Following a declarative paradigm, the screen automatically updates when values change, simplifying application state management and reducing the complexity of manual DOM manipulation.
 
-- **Optimized Rendering**: Re-rendering, painting, and layout recalculations are managed by the renderer pipeline, with optimizations applied to update only necessary parts.
+- **Optimized Rendering Pipeline**: Re-rendering, painting, and layout recalculations are managed by the renderer pipeline, with optimizations applied to update only necessary parts. This ensures high performance even with complex, data-heavy visualizations.
 
-- **Box Model Layout**: Users can easily compose layouts using the familiar Box model.
+- **Dual Renderer Support**: As a flexible rendering engine, Flitter supports both SVG and Canvas, meeting various graphic requirements. Developers can choose the appropriate renderer as needed, switching seamlessly between vector and bitmap graphics.
 
-- **SVG and Canvas Support**: Supports both SVG and Canvas, meeting various graphic requirements. Developers can choose the appropriate renderer as needed.
+- **Box Model Layout**: Users can easily compose layouts using the familiar Box model, providing a intuitive way to structure complex UIs within the rendering engine.
 
-- **Diverse Applications**: Can be utilized in various fields such as charts, diagrams, data visualization, and graphic editors.
+- **Diverse Applications**: Can be utilized in various fields such as charts, diagrams, data visualization, and graphic editors, leveraging the power of the underlying rendering engine.
 
 # Showcase
 Here are some examples of what you can create with Flitter:
@@ -39,18 +40,35 @@ Flitter can be used in various JavaScript environments. Here are installation an
 npm install @meursyphus/flitter
 ```
 
-```javascript
-import { Widget, Container, AppRunner } from '@meursyphus/flitter';
-
-// Using SVG renderer
-const svgElement = document.getElementById('mySvg');
-const svgRunner = new AppRunner({ view: svgElement });
-svgRunner.runApp(Container({ color: 'lightblue' }));
-
-// Using Canvas renderer
-const canvasElement = document.getElementById('myCanvas');
-const canvasRunner = new AppRunner({ view: canvasElement });
-canvasRunner.runApp(Container({ color: 'lightgreen' }));
+```javascript 
+import { Container } from "@meursyphus/flitter";
+
+/**
+ * canvas style must be set to 100%, 100%
+ * and you also must wrap div for canvas in order to calculate the size of the canvas
+ */
+document.querySelector<HTMLDivElement>("#app")!.innerHTML = `
+  <div style="width: 100vw; height: 100vh" id="container">
+    <canvas style="width: 100%; height: 100%;" id="view" />
+  </div>
+`;
+// Note: SVG is also supported
+// document.querySelector<HTMLDivElement>("#app")!.innerHTML = `
+//   <div style="width: 100vw; height: 100vh" id="container">
+//     <svg style="width: 100%; height: 100%;" id="view"></svg>
+//   </div>
+// `;
+const app = new AppRunner({
+  view: document.querySelector<HTMLCanvasElement>("#view")!,
+});
+/**
+ * you must set resizeTarget to calculate the size of the canvas
+ */
+app.onMount({
+  resizeTarget: document.querySelector<HTMLDivElement>("#container")!,
+});
+
+app.runApp(Container({ color: 'lightblue' }));
 ```
 
 ### React
@@ -68,23 +86,13 @@ const App = () => (
     <Widget
       width="600px"
       height="300px"
-      renderer="svg"
+      renderer="canvas" // or svg
       widget={Container({
         alignment: Alignment.center,
         color: 'lightblue',
         child: Text("Hello, Flitter SVG!", { style: TextStyle({ fontSize: 30, weight: 'bold' }) })
       })}
     />
-    <Widget
-      width="600px"
-      height="300px"
-      renderer="canvas"
-      widget={Container({
-        alignment: Alignment.center,
-        color: 'lightgreen',
-        child: Text("Hello, Flitter Canvas!", { style: TextStyle({ fontSize: 30, weight: 'bold' }) })
-      })}
-    />
   </>
 );
 ```
@@ -104,24 +112,13 @@ npm install @meursyphus/flitter @meursyphus/flitter-svelte
 <Widget
   width="600px"
   height="300px"
-  renderer="svg"
+  renderer="canvas" <!-- or "svg" -->
   widget={Container({
     alignment: Alignment.center,
     color: 'lightblue',
     child: Text("Hello, Flitter SVG!", { style: TextStyle({ fontSize: 30, weight: 'bold' }) })
   })}
 />
-
-<Widget
-  width="600px"
-  height="300px"
-  renderer="canvas"
-  widget={Container({
-    alignment: Alignment.center,
-    color: 'lightgreen',
-    child: Text("Hello, Flitter Canvas!", { style: TextStyle({ fontSize: 30, weight: 'bold' }) })
-  })}
-/>
 ```
 
 ## Usage Example
@@ -245,15 +242,18 @@ class BarState extends State<Bar> {
 
 ## Why Flitter?
 
-1. **Easy Learning Curve**: Uses syntax similar to Flutter, allowing mobile developers to easily adapt to the web environment.
+1. **Powerful Rendering Engine**: Flitter's core strength lies in its advanced rendering capabilities, allowing for smooth handling of complex graphics and animations.
+
+2. **Easy Learning Curve**: Uses syntax similar to Flutter, allowing mobile developers to easily adapt to the web environment while leveraging a powerful web-based rendering engine.
+
+3. **High Performance**: The optimized rendering pipeline ensures smooth performance even with complex, data-intensive visualizations.
 
-2. **High Performance**: Handles complex graphics smoothly with an optimized rendering pipeline.
+4. **Flexibility**: Abstracts SVG and Canvas manipulation, allowing developers to focus on business logic while the rendering engine handles the low-level drawing operations.
 
-3. **Flexibility**: Abstracts SVG and Canvas manipulation, allowing developers to focus on business logic.
+5. **Renderer Selection**: Can choose between SVG and Canvas renderers as needed, meeting various graphic requirements and allowing for the best performance in different scenarios.
 
-4. **Renderer Selection**: Can choose between SVG and Canvas renderers as needed, meeting various graphic requirements.
+6. **Reusability**: Increases code reusability through a component-based approach, enabled by the underlying rendering engine's architecture.
 
-5. **Reusability**: Increases code reusability through a component-based approach.
 
 ## Contributing