[IMP] Tutorial on Owl Components 🦉

awesome_owl/controllers/__init__.py

@@ -1,3 +1,3 @@
 # -*- coding: utf-8 -*-
 
-from . import controllers
+from . import controllers

awesome_owl/static/src/card/card.js

@@ -0,0 +1,21 @@
+/** @odoo-module **/
+
+import { Component, useState} from "@odoo/owl";
+
+export class Card extends Component {
+    static template = "awesome_owl.card";
+    static props = {
+        title: String,
+        slots: Object,
+        // content: String
+    };
+
+    setup() {
+        this.isOpen = useState({value:true});
+    }
+
+    toggleCardVisibility() {
+        this.isOpen.value = !this.isOpen.value;
+    }
+
+}

awesome_owl/static/src/card/card.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+    <t t-name="awesome_owl.card">
+      <div class="card d-inline-block m-2" style="width: 18rem;">
+        <div class="card-body">
+            <h5 class="card-title">
+              <t t-esc="props.title"/> | 
+              <button t-on-click="toggleCardVisibility">Toggle</button>
+            </h5>
+
+            <t t-if="isOpen.value" t-slot="body">
+              <p class="card-text">
+                Default Content
+              </p>
+            </t>
+        </div>
+      </div>
+    </t>
+</templates>

awesome_owl/static/src/counter/counter.js

@@ -0,0 +1,23 @@
+/** @odoo-module **/
+
+import { Component, useState} from "@odoo/owl";
+
+export class Counter extends Component {
+    static template = "awesome_owl.counter";
+    static props = {
+        onChange: {type: Function, optional:true}
+    }
+
+
+    setup() {
+        this.state = useState({ value: 0 });
+    }
+
+    increment() {
+        this.state.value = this.state.value + 1;
+
+        if(this.props.onChange){
+            this.props.onChange()
+        }
+    }
+}

awesome_owl/static/src/counter/counter.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+    <t t-name="awesome_owl.counter">
+      <span class="me-2">Counter: <t t-esc="state.value"/></span>
+      <button class="btn btn-primary" t-on-click="increment">Increment</button>
+    </t>
+</templates>

awesome_owl/static/src/playground.js

@@ -1,7 +1,22 @@
 /** @odoo-module **/
 
-import { Component } from "@odoo/owl";
+import { Component, useState, markup} from "@odoo/owl";
+import { Counter } from "./counter/counter"
+import { Card } from "./card/card";
+import { TodoList } from "./todo_list/todo_list";
+
 
 export class Playground extends Component {
     static template = "awesome_owl.playground";
+    static components = { Counter, Card, TodoList}
+    html_stuff = markup("<h2>hello</h2>")
+
+    setup() {
+        this.incrementSum = this.incrementSum.bind(this)
+        this.state = useState({ sum:0 });
+    }
+
+    incrementSum() {
+        this.state.sum++;
+    }
 }

awesome_owl/static/src/playground.xml

@@ -1,10 +1,20 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <templates xml:space="preserve">
-
     <t t-name="awesome_owl.playground">
-        <div class="p-3">
-            hello world
-        </div>
-    </t>
+        <Counter onChange="incrementSum"/>
+        <Counter onChange="incrementSum"/>
+        <p>Sum: <t t-esc="state.sum"/></p>
+        <br/>
 
+        <Card title="'Card 1'" >
+        </Card>
+        <Card title="'Card 2'">
+            <t t-set-slot="body">
+                <Counter/>
+            </t>
+        </Card>
+        <br/>
+
+        <TodoList/>
+    </t>
 </templates>

awesome_owl/static/src/todo_list/todo_item/todo_item.js

@@ -0,0 +1,23 @@
+/** @odoo-module **/
+
+import { Component, useState, markup} from "@odoo/owl";
+
+
+export class TodoItem extends Component {
+    static template = "awesome_owl.todo_item";
+
+    static props = {
+        todo: {type: Object, shape: {id: Number, description: String, isCompleted: Boolean}},
+        index: Number,
+        checkboxAction: Function,
+        removeAction: Function
+    }
+
+    checkboxChanged() {
+        this.props.checkboxAction(this.props.index)
+    }
+
+    removed() {
+        this.props.removeAction(this.props.index)
+    }
+}

awesome_owl/static/src/todo_list/todo_item/todo_item.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+  <t t-name="awesome_owl.todo_item">
+    <div t-att-class="{'text-muted': props.todo.isCompleted,'text-decoration-line-through': props.todo.isCompleted}">
+      <input type="checkbox" t-att-checked="props.todo.isCompleted" t-on-change='checkboxChanged'/>
+      <t t-esc="props.index"/>&#41;	<t t-esc="props.todo.description"/>
+      <span class="fa fa-remove" t-on-click="removed"/>
+    </div>
+  </t>
+</templates>

awesome_owl/static/src/todo_list/todo_list.js

@@ -0,0 +1,36 @@
+/** @odoo-module **/
+
+import { Component, useState, useRef, onMounted} from "@odoo/owl";
+import { TodoItem } from "./todo_item/todo_item"
+import { useAutoFocus } from "./../utils"
+
+
+export class TodoList extends Component {
+    static template = "awesome_owl.todo_list";
+    static components = { TodoItem }
+
+    setup() {
+        this.todos = useState([]);
+        useAutoFocus('todo_input');
+        this.toggleTodoState = this.toggleTodoState.bind(this);
+        this.removeTodoState = this.removeTodoState.bind(this);
+    }
+
+    addTodo(ev) {
+        console.log("creating a Todo")
+        if(ev.keyCode === 13 && ev.target.value){
+            this.todos.push({ id: this.todos.length, description: ev.target.value, isCompleted: false });
+        }
+    }
+
+    toggleTodoState(index) {
+        const target = this.todos[index];
+        target.isCompleted = !target.isCompleted
+    }
+
+    removeTodoState(index) {
+        if (index !== -1) {
+            this.todos.splice(index, 1);
+        }
+    }
+}

awesome_owl/static/src/todo_list/todo_list.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+    <t t-name="awesome_owl.todo_list">
+        <input t-ref="todo_input" t-on-keyup="addTodo" placeholder="'Enter a new task'"></input>
+        <h4>Todo List:</h4>
+        <t t-foreach="todos" t-as="item" t-key="item_index">
+            <TodoItem todo="item" index="item_index" checkboxAction="toggleTodoState" removeAction="removeTodoState"/>
+        </t>
+    </t>
+</templates>

awesome_owl/static/src/utils.js

@@ -0,0 +1,12 @@
+/** @odoo-module **/
+
+import { useRef, onMounted } from "@odoo/owl";
+
+export function useAutoFocus(ref_name) {
+    const refProxy = useRef(ref_name)
+    onMounted(() => {
+        if (refProxy.el) {
+            refProxy.el.focus()
+        }
+    })
+}