Supponiamo di voler realizzare un widget per la ricerca che sia composto da un campo di testo con validazione e un bottone. L’utente dovrà avere la possibilità di inserire del testo ma questo non deve contenere alcun numero all’interno.

Gli elementi HTML di cui avremo bisogno saranno un input per inserire il testo, un button per eseguire il controllo sui numeri e uno spazio che dovrà essere di default invisibile da dedicare ai messaggi di avviso.

Cominciamo quindi a mettere i tre elementi dentro un div contenitore per tenerli raggruppati e poter piazzare il nostro widget ovunque all’interno della pagina senza perderne il controllo.

<div class="search-widget">
  <input type="text"/>
  <button>Check</button>
</div>

Per quanto riguarda il JavaScript definiamo una classe che SearchComponent che accetti in input il dom del nostro widget e definisca quindi i comportamenti agli elementi interni.

function SearchComponent (widgetDom) {
  var input = widgetDom.querySelector("input"),
      button = widgetDom.querySelector("button");
  button.onclick = function () {};
  input.onkeypress = function () {};
}

Al click del bottone usiamo una semplice regex per controllare se ci sono presenti numeri all’interno del testo inserito e nel caso aggiungere una classe CSS al widget per gestire l’errore.

function SearchComponent (widgetDom) {
  var errorClass = " error", // we have to use some space to concat CSS classes
      input = widgetDom.querySelector("input"),
      button = widgetDom.querySelector("button");
  button.onclick = function () {
    widgetDom.className = widgetDom.className.replace(errorClass); // remove previous validation
    if (input.value.match(/[0-9]/)) {
      widgetDom.className += errorClass;
    }
  };
  input.onkeypress = fucntion () {};
}

Aggiungiamo anche un controllo sul campo di testo nel caso in cui l’utente voglia premere invio anzichè usare il bottone. In questo caso possiamo sfruttare la definizione dell’evento sul bottone per invocarlo senza riscriverlo. Ciò ci permette facilmente di gestire la validazione in un unico punto soltanto.

function WidgetSearch (widgetDom) {
  var errorClass = "error", // setting up some default classes for validation
      successClass = "success",
      input = widgetDom.querySelector("input"), // find elements inside the current widget
      button = widgetDom.querySelector("button");
  button.onclick = function () {
    widgetDom.className = widgetDom.className.replace(errorClass, "").replace(successClass, ""); // remove previous validation classes
    if (input.value.length === 0) {
      return; // don't perform validation if there is no text to validate
    }
    if (input.value.match(/[0-9]/)) { // regex validation
      widgetDom.className += " " + errorClass; // add a css class to handle error
    } else {
      widgetDom.className += " " + successClass;
    }
  };
  input.onkeypress = function (event) {
    if (event.keyCode === 13) { // 13 is the key code for return button
      var click = new Event("click"); // define the click event programmatically
      button.dispatchEvent(click) // fire the event on the button simulating the user click
    }
  }
}

Le funzionalità del nostro widget sono ora pronte e rimane da gestire la messaggistica della validazione.

<div class="widget-search">
  <div class="input">
    <input type="text"/>
    <button>Check</button>
  </div>
  <div class="message">
    <div class="message-error">There are numbers in the text.</div>
    <div class="message-success">The text is clear.</div>
  </div>
</div>

Impacchettando gli elementi HTML possiamo meglio gestirne gli stili usando dei selettori CSS parlanti.

Definiamo un set di regole semplici per avere una base di grafica che possa rispecchiare le specifiche dell’esercizio.

Mettiamo il campo di testo e il bottone allineati uno vicino all’altro e i messaggi sotto.

.input * {margin-right: -5px;}  // stick the inputs together
.input input {border-radius: 10px 0 0 10px;}  // add some cool style
.input button {border-radius: 0 10px 10px 0;}
.message * {display: none;}  // the messages
.message-error {color: red;}
.message-success {color: green;}
.error .message-error {display: block;} // show relative message to validation result
.success .message-success {display: block;}

Il nostro widget è finalmente completato nella sua struttura. Per poterlo usare nella nostra applicazione ora dobbiamo solo invocarlo al caricamento della pagina istanziando un nuovo widget di tipo WidgetSearch.

window.onload = function () {
  var widget = document.querySelector(".widget-search");
  new WidgetSearch(widget)
}

Ci sono ora un paio di regole che devono essere tenute a mente usando un componente così definito con CSS e JavaScript.

Gli stili che abbiamo creato potrebbero essere troppo generici all’interno della nostra applicazione, quindi il consiglio è quello di usare, per tutto ciò che non vogliamo sia condiviso con altri elementi HTML in pagina, una root riferita al contenitore per limitare il più possibile overrides.

.widget-search .input * {margin-right: -5px;}
.widget-search .input input {border-radius: 10px 0 0 10px;}
.widget-search .input button {border-radius: 0 10px 10px 0;}
.widget-search .message * {display: none;}
.widget-search .message-error {color: red;}
.widget-search .message-success {color: green;}
.widget-search .error .message-error {display: block;}
.widget-search .success .message-success {display: block;}

Inoltre se volessimo usare più volte nella stessa pagina questo componente dobbiamo tenere presente che va istanziato un nuovo WidgetSarch per ogni elemento. Quindi dovremo aggiungere un ciclo per scorrere tutti i widget in pagina e inizializzarli.

window.onload = function () {
  var widgets = document.querySelectorAll(".widget-search");
  widgets.forEach(function(widget) {
    new WidgetSearch(widget)
  })
}

Infine potremmo creare un sistema automatizzato di inizializzazione di tutti i possibili widget in pagina passando per i data attribute.

Aggiungiamo un data-widget al nostro componente in modo da passargli il valore della classe JavaScript da istanziare e cambiamo il ciclo dentro window.onload per leggere tutti i data-widget in pagina.

<div class="widget-search" data-widget="WigetSearch">
  ...
</div>

window.onload = function () {
  var widgets = document.querySelectorAll("[data-widget]");  // get all elements with that data attribute
  widgets.forEach(function (widget) {
    var className = widget.dataset.widget;  // read the data attribute value
    new window[className](widget);  // get the class from the container of all of them, from window if it's defined at global level, otherwhise other variables
  })
}

In JavaScript qualunque oggetto ha una struttura che lo definisce con proprietà e metodi nativi che non possiamo ne sovrascrivere ne modificare. Sebbene i valori nativi siano disponibili in sola lettura, possiamo aggiungerne di nuovi e manipolarli a piacimento.

Vediamo ora come applicare questo alla programmazione ad oggetti e scoprire quali vantaggi può offrirci.

Definiamo una semplice classe Person che costruiremo man mano ampliandone il suo prototype.

function Person () {};

Person.prototype // {constructor: function(){...}, ...}

Il suo prototype nativo conterrà solo il metodo constructor che viene invocato quando generiamo una nuova istanza e va ad eseguire il codice della classe stessa, e altri metodi ereditati dalla super classe Object.

Aggiungiamo due nuovi metodi per scrivere e leggere il nome della persona

Person.prototype.setName = function (value) { this.name = value };
Person.prototype.getName = function () { this.name = value };

var p = new Person();
p.setName("John");
p.getName(); // "John"

I metodi appena definiti sono diventati nativi per la funzione Person e quindi disponibili alle sue istanze e a ciascuna di queste andranno a rispettivamente a creare e leggere la proprietà name.

Possiamo migliorare l’efficienza di questi due metodi fondendoli in uno solo.

Person.prototype.name = function (value) {
  if (value) {
    this._name = value
  } else {
    return this._name
  }
}

In questa maniera ora avremo un solo metodo name al quale se passiamo un parametro setterà la proprietà altrimenti la leggerà.

var p = new Person();
p.name("John");
p.name(); // "John"

Importante. Abbiamo dovuto però rinominare this.name in this._name per evitare di fare confusione tra metodo e proprietà, altrimenti, una volta invocato il metodo name con un parametro in input andiamo a ridefinire cosa sia name stesso, trasformandolo in un valore e quindi non potendolo più usare successivamente come funzione, ottenendo in console un errore come il seguente.

var p = new Person();
p.name("John");
p.name(); // "Uncaught TypeError: p.name is not a function(…)"
p.name; // "John"
p.name("Smith"); // "Uncaught TypeError: p.name is not a function(…)"
p.name = "Smith";
p.name; // "Smith"

I vantaggi di aggiungere metodi al prototype di una function riguardano soprattutto l’aspetto computazione e occupazione di risorse di memoria. Infatti questi metodi, visti allo stesso livello di quelli nativi, vengono allocati una sola volta e associati ad ogni istanza successiva pur mantenendo il contesto indipendente l’una dall’altra.

In altre parole non viene allocato uno spazio di memoria per ogni metodo name di ogni eventuale var p1, p2, …, ma ne viene allocato uno solo al momento della definizione di Person e poi ereditato dalle istanze e su grandi numeri sia di metodi che di istanze è sicuramente da tenere a conto per le performance.

D’altro canto però per scambiare informazioni tra due metodi diversi o uno con condizioni all’interno come l’esempio precedente di name, dobbiamo per forza definire delle variabili di classe con il rischio innanzitutto di name overriding e in secondo luogo di rendere visibili delle proprietà che preferiremmo rimanessero nascoste all’utente.

Nell’esempio precedente infatti abbiamo voluto mettere a disposizione dell’utente un semplice metodo per manipolare la proprietà name ma per fare ciò abbiamo dovuto creare una proprietà _name di supporto per salvare e leggere il valore, rendendo a questo punto superfluo il metodo stesso.

Per situazioni del genere sicuramente una soluzione migliore potrebbe essere quella di definire all’interno della funzione Person stessa metodi e variabili di supporto nascoste, a patto di accettare un uso maggiore di memoria.

function Person () {
  var name;
  this.name = function (value) {
    if (value) name = value;
    else return name;
  }
}

var p = new Person();
p.name("John");
p.name(); // "John"
p.name; // function ...