Ce blog a déménagé et parle maintenant uniquement anglais.

This blog has moved and now only speaks English.

blog.floriancargoet.com

See you there!

/home/florian

le blog de florian cargoet : du linux, du web et du logiciel libre



Categorie: Ext JS

[EN] Use PhantomJS to take screenshots of your webapp for you

6 January, 2012 (20:51) | Ext JS, Webdev | Florian Cargoet

Problem

You’ve built a web application and it’s time to write the user documentation. Your app is localized and you ship new features every three months.

In your documentation, you want screenshots of specific parts of your application: the login box, the collapsed Help panel, the main data grid…

You need to take screenshots in 4 languages.

Do you want to take them manually? You could probably define a bunch of rectangular zones and automate the process but the login box is bigger in French than in English since the text is longer. And in six months, you’ll ship a feature which will require a change in the global application layout.

Do you want to define your rectangular zones 4 times? And redefine them (4 times) whenever you resize/move a component?

Solution: component based screenshots

What if you could tell: “Take a screenshot of this div” instead of “Take a screenshot of this app and cut here, here and there”?

Even better: “Take a screenshot of this <insert your favorite UI framework> component”.

With PhantomJS, you can.

Installation

There are builds for Windows and MacOS X available on the download page, there is brew install phantomjs, there is a PPA for Ubuntu, and there are several git repositories.

I chose to compile it on my 32 bits Ubuntu computer:

sudo apt-get install libqt4-dev libqtwebkit-dev qt4-qmake
git clone git://github.com/ariya/phantomjs.git
cd phantomjs
git checkout 1.4.1
qmake-qt4
make

There is no install target in the Makefile so do whatever you usually do in this case (move/symlink the binary to /usr/bin/, add the bin/ directory in your $PATH, use the full path when invoking phantomjs…). The PhantomJS binary is bin/phantomjs.

Usage

phantomjs your_script.js [parameters]

Examples

You can find some examples on the site. Here are some of them:

Load a web page:

?View Code JAVASCRIPT
var page = new WebPage();
 
page.open(url, function (status) {
  // do something
});

Take a screenshot a a page:

?View Code JAVASCRIPT
var page = new WebPage(),
    address, output, size;
 
if (phantom.args.length < 2 || phantom.args.length > 3) {
    console.log('Usage: rasterize.js URL filename');
    phantom.exit();
} else {
    address = phantom.args[0];
    output = phantom.args[1];
    page.viewportSize = { width: 600, height: 600 };
    page.open(address, function (status) {
        if (status !== 'success') {
            console.log('Unable to load the address!');
        } else {
            window.setTimeout(function () {
                page.render(output);
                phantom.exit();
            }, 200);
        }
    });
}

Evaluate some JS code in the context of the web page:

?View Code JAVASCRIPT
var page = new WebPage();
page.open(url, function (status) {
    var title = page.evaluate(function () {
        return document.title;
    });
    console.log('Page title is ' + title);
});

Combine of these possibilities and you have a nice screenshotting solution!

Component screenshotting

With PhantomJS, this is really simple:

  1. Load your app
  2. Find your divs / Find your components
  3. Get their bounding boxes (top, left, width, height)
  4. Render with clipRect

Example with an ExtJS demo app:

This is a RSS feed viewer and I want screenshots of:

  • The left panel
  • The preview button
  • The whole application, with the left panel collapsed

Here it is:

?View Code JAVASCRIPT
var page    = new WebPage(),
    address = 'http://dev.sencha.com/deploy/ext-4.0.7-gpl/examples/feed-viewer/feed-viewer.html';
 
page.viewportSize = {
    width  : 800,
    height : 600
};
 
// define the components we want to capture
var components = [{
    output : 'feed-viewer-left.png',
    //ExtJS has a nice component query engine
    selector : 'feedpanel'
},{
    output : 'feed-viewer-preview-btn.png',
    selector : 'feeddetail > feedgrid > toolbar > cycle'
},{
    output : 'feed-viewer-collapsed.png',
    //executed before the rendering
    before : function(){
        var panel = Ext.ComponentQuery.query('feedpanel')[0];
        panel.animCollapse = false; // cancel animation, no need to wait before capture
        panel.collapse();
    },
    selector : 'viewport'
}];
 
page.open(address, function (status) {
    if (status !== 'success') {
        console.log('Unable to load the address!');
    } else {
        /*
         * give some time to ExtJS to
         *   - render the application
         *   - load asynchronous data
         */
        window.setTimeout(function () {
            components.forEach(function(component){
                //execute the before function
                component.before && page.evaluate(component.before);
                // get the rectangular area to capture
                /*
                 * page.evaluate() is sandboxed
                 * so that 'component' is not defined.
                 *
                 * It should be possible to pass variables in phantomjs 1.5
                 * but for now, workaround!
                 */
                eval('function workaround(){ window.componentSelector = "' + component.selector + '";}')
                page.evaluate(workaround);
 
                var rect = page.evaluate(function(){
                    // find the component
                    var comp = Ext.ComponentQuery.query(window.componentSelector)[0];
                    // get its bounding box
                    var box = comp.el.getBox();
                    // box is {x, y, width, height}
                    // we want {top, left, width, height}
                    box.top  = box.y;
                    box.left = box.x;
                    return box;
                });
                page.clipRect = rect;
                page.render(component.output);
            });
            // job done, exit
            phantom.exit();
        }, 2000);
    }
});

Result

And here are the screenshots:

feed-viewer-left
feed-viewer-preview-btn
feed-viewer-collapsed

Conclusion

Now, we can automate screenshotting of specific components, even if we don’t know their position or size. Relaunch this script with your application in Spanish and voilà: 3 Spanish screenshots in 5 seconds, even if the button is bigger (or smaller, I don’t speak Spanish)!

Ideas:

  • Components to capture defined in the app itself
  • Browser extension/Bookmarlet to define the components to capture just by clicking on it
  • Use it for unit testing, with image comparison
  • Make a product of this, make profit

I hope you liked it!

[EN] Ext.ux.KeySequenceMap

14 January, 2011 (21:37) | Ext JS | Florian Cargoet

Here is a useless extension I wrote for fun : Ext.ux.KeySequenceMap. As its name suggests, it’s based on Ext.KeyMap and it handles sequences of keys instead of unique keys.

Lire la suite »

[FR] Ext.ux.KeySequenceMap

14 January, 2011 (21:36) | Ext JS | Florian Cargoet

Voici une extension inutile (donc indispensable) que j’ai écrite pour m’amuser : Ext.ux.KeySequenceMap. Comme son nom l’indique, cette classe hérite de Ext.KeyMap et gère des séquences de touches plutôt que des touches uniques.

Lire la suite »

ExtJS EditorGridPanel, validation et accès au record dans le validator

14 March, 2010 (20:57) | Ext JS, Webdev | Florian Cargoet

Si vous n’avez jamais utilisé l’EditorGridPanel d’ExtJS, le titre peut paraitre un peu obscur donc je vais commencer par rappeler ce qu’est l’EditorGridPanel ainsi que les possibilités de validation offertes par ExtJS. Enfin, l’objet principal de cet article, nous verrons comment pousser un peu plus loin les possibilités du validator en lui donnant accès aux autres colonnes de l’EditorGridPanel.

Cet article mélange donc une introduction à l’EditorGridPanel, une présentation de quelques techniques de validation et une technique avancée pour aller plus loin. Il y en a donc pour tous les niveaux, faites le tri. Lire la suite »

ExtJS : Afficher un titre sur les régions “collapsed”

13 December, 2009 (01:50) | Ext JS, Notes | Florian Cargoet

Le border layout d’ExtJS est excellent mais souffre quand même d’un défaut important : les régions réduites  (collapsed) n’affichent plus aucune information ce qui empêche, par exemple, de les identifier. Il serait judicieux d’afficher au moins le titre du panel réduit afin de savoir à quoi correspond cette région “masquée”.

Pour visualiser un peu le problème, vous pouvez jeter un oeil à la démo du layout sur le site d’ExtJS et cliquer sur le bouton permettant de réduire la zone “South”.  Une fois réduit, le rectangle qui représente le panel réduit n’apporte pas beaucoup d’informations…

Pour accéder à ce rectangle et y insérer ce que vous voulez :

?View Code JAVASCRIPT
var component = Ext.getCmp(15);
var el = component.layout.south.collapsedEl;
el.insertHtml('afterBegin','&lt;span style="position: relative; top: 4px; left: 5px; color: #15428b; font-family: tahoma,arial,verdana,sans-serif; font-size: 11px; font-weight: bold;"&gt;Et voilà un titre&lt;/span&gt;');

Attention : l’élément collapsedEl n’existe qu’après la première réduction du panel donc il faut jouer avec l’évènement collapse.

ExtJS : changer le style d’un bouton dynamiquement

25 October, 2009 (23:32) | Ext JS, Webdev | Florian Cargoet

ExtJS est assez riche au niveau des boutons et permet de contrôler finement leur aspect à l’instanciation. Il est possible d’indiquer une icône (ou une classe qui mettra l’icône en background), d’ajouter un texte, de choisir si l’icône est à gauche, à droite, au dessus ou en dessous du texte. Les boutons peuvent avoir 3 tailles différentes (small, medium et large) et on peut associer un menu à un bouton ce qui se matérialise par une petite flèche sur le bouton que l’on choisit de placer à droite ou en dessous. Cela donne beaucoup de combinaisons possibles que vous pouvez voir en démo ici : http://www.extjs.com/deploy/dev/examples/button/buttons.html

Malheureusement, une fois ces superbes boutons créés, il n’est plus possible de modifier grand chose… Vous pouvez encore changer la classe qui met l’icône en background (unBouton.setIconClass(‘icon-class’); ) mais impossible de changer la taille du bouton, le placement de l’icône ou celui de la flèche du menu. De même, si un bouton n’a pas d’icône à la création, en ajouter une après coup va poser problème.

J’ai donc ajouté une petite méthode à la classe Ext.Button qui permet de changer tout ça même après la création des boutons ! Lire la suite »

Extjs : les ajouts au prototype de Function

9 September, 2009 (22:31) | Ext JS, Webdev | Florian Cargoet

Si vous développez en Javascript, vous savez certainement que les objets ont un prototype et qu’on peut le modifier dynamiquement. On peut ainsi ajouter des fonctionnalités aux objets standards du Javascript (la librairie Prototype en fait d’ailleurs un usage intensif). Dans cet article, je vais me concentrer sur les ajouts fait par ExtJS à Function.

Lire la suite »

ExtJS : Boutons à plusieurs icônes

29 August, 2009 (10:16) | Ext JS, Webdev | Florian Cargoet

Voilà une nouvelle extension ExtJS. Elle permet à un bouton d’avoir plusieurs icônes qui sont permutées à chaque clic. Très utile pour un bouton toggle à deux états, on peut aussi l’utiliser pour un bouton cyclique avec autant d’états que l’on veut. Avant de regarder le code, vous pouvez jetter un oeil à la démo.

Lire la suite »

[Update] ExtJS : Bouton asynchrone

16 August, 2009 (12:32) | Ext JS, Webdev | Florian Cargoet

Petite mise à jour de mon extension ExtJS LoadButton
Lire la suite »

ExtJS : bouton asynchrone

3 July, 2009 (23:28) | Ext JS, Webdev | Florian Cargoet

Lorsqu’on crée un bouton avec ExtJS, par exemple un bouton de toolbar (xtype : ‘tbbutton’), on peut préciser un handler qui est une fonction à exécuter quand on clique sur le bouton. Comme il arrive que le handler soit une action asynchrone (avec un appel AJAX par exemple), j’ai réalisé une petite extension qui permet de remplacer l’icône d’un bouton par une icône de chargement pendant que le handler s’exécute. Avant de regarder le code, vous pouvez directement tester la démo.

Lire la suite »