OOUI/A propos de la bibliothèque

OOUI est une bibliothèque permettant aux développeurs de créer rapidement des applications web d'interface utilisateur, compatibles avec une multitude de navigateurs.

La bibliothèque OOUI contient :

• un ensemble de widgets, d'affichages et de fenêtres, prêt à être utilisé et pouvant être instancié directement ou facilement étendu,
• un composant côté serveur qui génère des sorties compatibles en PHP dans la cas où JavaScript n'est pas pris en charge,
• des éléments qui peuvent être facilement mélangés et assemblés pour créer des interfaces utilisateur personnalisées.

La bibliothèque assure :

• la compatibilité entre navigateurs. Les interfaces construites en utilisant les éléments de la bibliothèque apparaîtront et se comporteront de manière cohérente sur les navigateurs modernes.
• la compréhensibilité. Les interfaces partagent une API commune qui est bien documentée et utilisée de manière cohérente. A la fois les composants JavaScript et les composants PHP utilisent les mêmes noms de classes et de méthodes. Les éléments de base sont réutilisés à partir de la bibliothèque en même temps que leurs APIs.
• l'architecture Les thèmes indiquent l'aspect et le comportement des interfaces OOUI. Deux thèmes sont fournis séparément : le thème par défaut WikimediaUI qui suit le guide de style d'architecture de la Fondation Wikimedia et un autre thème appelé Apex inspiré de l'habillage Apex. Les auteurs d'habillages peuvent créer des thèmes supplémentaires et les utiliser dans MediaWiki pour avoir un aspect et un comportement personnalisé.
• la gestion des événements sensibles. Les composants OOUI écoutent les événements de bas niveau et émettent un événement significatif au bon moment (par exemple quand quelque chose est actuellement modifié).
• la réactivité. Lorsque le modèle est modifié, la vue est mise à jour automatiquement.
• l'accessibilité. Les widgets WikimediaUI s'alignent par défaut sur le niveau de conformité AA des WCAG.
• l'efficacité. L'affichage est généré et mis à jour au niveau du client afin de réduire les échanges avec le serveur.
• la fonctionnalité orientée objet. La bibliothèque fournit un support pour les mixins et pour l'héritage, y compris celui des propriétés statiques.
• l'ouverture. La bibliothèque est à source libre et elle est diffusée sous licence MIT.

OOUI est disponible comme bibliothèque du noyau MediaWiki de la version 1.23. Elle a été initialement créée pour être utilisée dans VisualEditor, qui s'en sert pour l'ensemble de son interface utilisateur.

Compatibilité, dépendances et installation

OOUI est compatible avec la plupart des navigateurs web modernes, et nous continuons à prendre en charge des navigateurs supplémentaires. Voir la documentation de l'Editeur Visuel pour avoir une idée des navigateurs actuellement pris en charge. Notez que OOUI prend en charge un sur-ensemble de ces navigateurs, car la compatibilité de VisualEditor est particulièrement restreinte à cause de son utilisation pour l'édition de contenu.

La bibliothèque OOUI dépend de OOjs et de jQuery qui tous deux appartiennent au noyau MediaWiki.

Vous trouverez les instructions sur l'utilisation de la bibliothèque dans les extensions MediaWiki.

Documentation supplémentaire

Ces ressources peuvent vous être utiles :

• Documentation du code JavaScript — La documentation générée pour l'interface JavaScript fournit une référence complète de l'API, avec la description de chaque classe et de toutes ses options de configuration supportées et ses méthodes. Chaque description comprend également une liste de classes et de sous-classes mixin.
• La documentation PHP — L'API PHP est documentée en utilisant les conventions MediaWiki et elle peut être utilisée pour générer une référence lisible (la documentation PHP peut manquer d'informations sur les méthodes mixin).
• Démonstrations — démos supplémentaires.
• Documentation OOjs — La bibliothèque OOUI est construite en parallèle de OOjs et utilise les fonctions de celui-ci. La documentation générée à partir du code peut également vous être utile.

Participer

Rejoignez le canal IRC #wikimedia-editing ^connecter, un très bon endroit pour poser vos questions, obtenir de l'aide et rencontrer les autres développeurs.

Les bogues peuvent être envoyés sur Phabricator et marqués de l'étiquette OOUI pour leur suivi.

Si vous souhaitez participer au projet, n'hésitez pas à faire un petit coucou sur notre canal IRC, ... alors, à tout de suite.