King of App themes

¿Qué es un tema de king of App?

Un tema es un conjunto de componentes con un estilo propio. Creando un tema podremos personalizar al 100% una app.

Un tema desarrollado para King of App se compone de un conjunto de componentes de Polymer.

Empezamos – Crear temas.

Una manera fácil y sencilla para crear temas rápidamente es utilizar nuestra herramienta de línea de comandos.

Con esta herramienta podemos generar toda la estructura de archivos y contenido que necesitamos para empezar a desarrollar el nuevo tema.

Una vez tenemos la herramienta de línea de comandos instalada globalmente podremos crear el tema desde cualquier lugar de nuestro sistema, aunque lo recomendado es hacerlo desde la carpeta donde esté alojado el Visualizer.

Estructura

Esta es la estructura básica de un módulo. El módulo tiene una estructura similar a otros elementos (spinners, temas, etc…) y requiere de su carpeta con los diversos archivos de configuración.

  koapp-theme-mythemename
  ├── elements
  │   ├── mythemename-badge
  │   │    ├── demo
  │   │    │   └── index.html
  │   │    └── mythemename-badge.html
  │   ├── ...
  │
  ├── styles
  │   ├── default-theme.html
  │   └── main.css
  ├── .bowerrc
  ├── .gitignore
  ├── bower.json
  ├── config.json
  └── koapp-theme-mythemename.html

Incluir nuestro tema en el Visualizer

El Visualizer sirve para previsualizar los temas o módulos que se van a desarrollar, se puede ver aquí la documentación completa Visualizer, es decir, carga de forma dinámica los temas y módulos leyendo de un JSON como el que aparece a continuación. Por tanto, solo instanciándolo ya se puede empezar a trabajar en el tema nuevo.

  • app/core/structure.json:
    {
    "config": {
      ...
      "theme": {
        "identifier": "koapp-theme-mythemename",
        "path": "themes/koapp-theme-mythemename/koapp-theme-mythemename.html"
      },
      ...
    },
    ...
    }

¡Empezemos con los cambios!

  • En el visualizer: http://localhost:9001
  • La demo de cada componente.
    • Ejemplo: http://localhost:9001/themes/koapp-theme-mythemename/elements/mythemename-button/demo/

Personalizando el tema con componentes, ¿Qué son los componentes?

Un componente es un conjunto de estándares para crear elementos HTML reutilizables.

Por ejemplo, si se desea crear un carrusel de imágenes, se puede crear un nuevo elemento HTML implementando todo el contenido de JavaScript (comportamiento) y de CSS (estilo) dentro del propio elemento. Después de eso, se puede utilizar este elemento en cualquier parte de su documento.

Sobre los componentes

Cada componente está contenido en su propio directorio y debe seguir una nomenclatura determinada (nombreDelTema-componente). Para facilitar mantener esta correlación, se puede utilizar nuestra herramienta de linea de comandos que construye toda la estructura necesaria de manera automática.

Dentro de la carpeta de nuestro componente siempre se debe incluir una subcarpeta con un demo.html, que facilitará posteriormente el desarrollo. También será la herramienta quien se encargará de incluir esto de manera automática.

  • Estructura:
awesometheme-button
├── demo
│   └── index.html
└── awesometheme-button.html

Cada componente contiene un KoaBehavior desde el que se gestionan el resto de componentes necesarios (host attributes, propiedades, etc…).

KoaBehavior: Es un comportamiento (Polymer behavior) que contiene la mayoría de los componentes de comportamiento como atributos, métodos, etc…

  • Elementos incluidos en KoaBehavior:
Elemento Utilidad Documentación
Behaviors Gestiona la herencia entre propiedades y métodos. Polymer behaviors
Host attributes Permite definir los estilos durante la creación del componente. Polymer host attributes
Properties Gestiona las propiedades. Polymer properties
Styling Permite utilizar CSS customizado y mixins. Polymer styling
Methods Métodos de Polymer expuestos. Polymer Instance methods

Lista de componentes

Esta es la lista de los componentes disponibles para un tema.

Modificando un componente

Partiendo de la típica estructura de un componente…

mythemename-button
├── demo
│   └── index.html
└── mythemename-button.html

En mythemename-button.html se pueden hacer cambios en el componente.

La estructura interna:

<!-- write your imports here -->

<dom-module id="mythemename-button">
  <template>
    <!-- write your styles here -->
    <style>

    </style>
    <!-- end styles -->

    <!-- write your template here -->

    <!-- end template -->
  </template>

  <script>
    Polymer({
      is: 'mythemename-button',

      behaviors: [
        Polymer.KoaButtonBehavior
      ],

      // Logic here. hostAttributes, behaviors: [], properties, methods, etc
    });
  </script>
</dom-module>

La herramienta de línea de comandos ya incluye imports, hostAttributes, behaviors, properties, methods, etc.

Por ejemplo en koa-button:

<link rel="import" href="../../../../bower_components/polymer/polymer.html">
<link rel="import" href="../../../../bower_components/koa-behaviors/koa-button-behavior.html">

<dom-module id="mythemename-button">
  <template>
    <!-- write your styles here -->
    <style>

    </style>
    <!-- end styles -->

    <!-- write your template here -->

    <!-- end template -->
  </template>

  <script>
    Polymer({
      is: 'mythemename-button',

      behaviors: [
        Polymer.KoaButtonBehavior
      ]
    });
  </script>
</dom-module>

Pasos para customizar un componente.

  1. Añadir la plantilla

    <content></content>

    Nota: <content> provee un punto de inserción.

  2. Añadir los estilos

    :host {
    cursor: pointer;
    display: inline-block;
    font-size: 14px;
    font-weight: 400;
    line-height: 1.42857143;
    margin-bottom: 0;
    padding: 6px 12px;
    text-align: center;
    vertical-align: middle;
    white-space: nowrap;
    }
    :host(:not[link]) {
    background-color: #fff;
    border-radius: 4px;
    border: 1px solid #ccc;
    color: #333;
    }
    :host([link]) {
    color: #23527c;
    text-decoration: underline;
    }
    :host([active]),
    :host([pressed]) {
    color: #333;
    background-color: #e6e6e6;
    border-color: #adadad;
    }
    :host([big]) {
    border-radius: 6px;
    font-size: 18px;
    line-height: 1.3333333;
    padding: 10px 16px;
    }
    :host([disabled]) {
    background-color: #e0e0e0;
    border-color: #ccc;
    }
    :host([focused]) {
    background-color: #e6e6e6;
    border-color: #8c8c8c;
    color: #333;
    text-decoration: none;
    }

    Nota: El selector :host se selecciona a si mismo.

Ahora ya tenemos el componente custom:

<link rel="import" href="../../../../bower_components/polymer/polymer.html">
<link rel="import" href="../../../../bower_components/koa-behaviors/koa-button-behavior.html">

<dom-module id="mythemename-button">
  <template>
    <!-- write your styles here -->
    <style>
      :host {
        cursor: pointer;
        display: inline-block;
        font-size: 14px;
        font-weight: 400;
        line-height: 1.42857143;
        margin-bottom: 0;
        padding: 6px 12px;
        text-align: center;
        vertical-align: middle;
        white-space: nowrap;
      }
      :host(:not[link]) {
        background-color: #fff;
        border-radius: 4px;
        border: 1px solid #ccc;
        color: #333;
      }
      :host([link]) {
        color: #23527c;
        text-decoration: underline;
      }
      :host([active]),
      :host([pressed]) {
        color: #333;
        background-color: #e6e6e6;
        border-color: #adadad;
      }
      :host([big]) {
        border-radius: 6px;
        font-size: 18px;
        line-height: 1.3333333;
        padding: 10px 16px;
      }
      :host([disabled]) {
        background-color: #e0e0e0;
        border-color: #ccc;
      }
      :host([focused]) {
        background-color: #e6e6e6;
        border-color: #8c8c8c;
        color: #333;
        text-decoration: none;
      }
    </style>
    <!-- end styles -->

    <!-- write your template here -->
    <content></content>
    <!-- end template -->
  </template>

  <script>
    Polymer({
      is: 'mythemename-button',

      behaviors: [
        Polymer.KoaButtonBehavior
      ]
    });
  </script>
</dom-module>

CSS propiedades customizadas y mixins

Los temas de King of App utilizan propiedades CSS customizadas.

Definición de propiedades CSS customizadas

En styles/default-theme.html se define el valor de las variables.

Ejemplo:

:root {
  --primary-text-color: #636363;
  --primary-background-color: #ffffff;
  --secondary-text-color: #636363;
  --disabled-text-color: #2f2b16;
  /* ... */
}

También, es necesario definir esos valores en la parte de defaultConfig – colors del config.json.

Ver config.json > defaultConfig > colors

Usando propiedades CSS customizadas

En la etiqueta <style is="custom-style">, puedes utilizar propiedades CSS customizadas.
Sintaxis:

var(variable, defaultValue)
<style is="custom-style">
  :host {
    color: var(--button-text-color, #ffffff);
  }
</style>

También puedes utilizar otra propiedad CSS cutomizada como valor por defecto:

<style is="custom-style">
  :host {
    color: var(--button-text-color, --primary-text-color);
  }
</style>

Definición de fuentes

Por el momento solo soportamos Google Fonts como fuentes externa.

En default-theme.html se definen las fuentes.

Ejemplo:

<style is="custom-style">
  :host {
    /* ... */
    --primary-font-family: 'Roboto';
    --title-font-family: 'Verdana';
    /* ... */
  }
</style>

También, es necesario definir esos valores en la parte de defaulConfig – fonts del config.json.

Ver config.json > defaultConfig > fonts

Color de fondo e imagen de fondo

En styles/default-theme.html se definen.

Ejemplo:

<style is="custom-style">
  :host {
    --background-color: #f8ecc2;
    --background-image: url('images/background.png');
  }
</style>

También, es necesario definir esos valores en la parte de defaultConfig – colors del config.json.

Ver config.json > defaultConfig > colors

En caso de ser una imagen también es necesario definir esos valores en la parte de defaultConfig – images del config.json.

Ver config.json > defaultConfig > images

Colores

En styles/default-theme.html se definen.

Ejemplo:

<style is="custom-style">
  :root {
    --primary-text-color: #212121;
    --primary-background-color: #ffffff;
    --secondary-text-color: #737373;
    --disabled-text-color: #9b9b9b;
    --divider-color: #dbdbdb;
    --primary-color: #3f51b5;
    --light-primary-color: #c5cae9;
    --dark-primary-color: #303f9f;
    --accent-color: #ff4081;
    --light-accent-color: #ff80ab;
    --dark-accent-color: #f50057;
    --error-color: #dd2c00;

    --background-color: #ffffff;
  }
</style>

También, es necesario definir esos valores en la parte de defaultConfig – colors del config.json.

Ver config.json > defaultConfig > colors

Set de iconos

Se puede crear un set de iconos utilizando Polymer iron-iconset-svg.

El componente iron-iconset-svg permite definir un set de iconos personalizado utilizando svg.

Los componentes de icono svg deberían ser hijos del componente iron-iconset-svg. En el caso de crear múltiples iconos es importante definir diferentes id´s para identificarlos.

Si se desea dar soporte a todos los iconos, se puede utilizar PolymerElements/iron-icons/iron-icons.html y editar las rutas svg.

Ejemplo:

<link rel="import" href="../iron-icon/iron-icon.html">
<link rel="import" href="../iron-iconset-svg/iron-iconset-svg.html">

<iron-iconset-svg name="myiconsetname" size="24">
  <svg>
    <defs>
      [...]
      <g id="add"><path d="M19 13h-6v6h-2v-6H5v-2h6V5h2v6h6v2z"/></g>
      <g id="arrow-drop-down"><path d="M7 10l5 5 5-5z"/></g>
      <g id="arrow-drop-up"><path d="M7 14l5-5 5 5z"/></g>
      [...]
    </defs>
  </svg>
</iron-iconset-svg>

Menú

Este valor del config.json deberá ser un string que indique el identifier del módulo del tipo menú que tenha nuestro tema por defecto. El polymermenu viene definido por defecto, pero podríamos seleccionar cualquiera que esté publicado en kingofapp.

Esta propiedad solo tiene efecto de cara a subir el tema a producción, por tanto, no será necesario tener dicho menú previamente descargado, aunque si queremos ver como queda en localhost deberemos disponer del mismo.

Más cosas del config.json

Documentación relacionada Ejemplos de uso