Création de snippets

Création

En général, un modèle de snippet .snippet doit retourner directement une table, par exemple :

return {
    name = '测试片段';  -- Nom du snippet
    description = '用于测试各选择器的功能';  -- Description du snippet
    arguments = {  -- Liste des sélecteurs du snippet
        {  -- Sélecteur 1
            type = 'app',  -- Type de sélecteur
            title = '选择应用',  -- Titre du sélecteur
            subtitle = '请选择一个应用',  -- Sous-titre du sélecteur
            default = 'com.xxtouch.XXTExplorer',  -- Valeur par défaut du sélecteur
        },
        {  -- Sélecteur 2
            type = 'loc',
            title = '选择地理位置',
            subtitle = '请随便选择一个地理位置',
            default = xui.get("com.darwindev.XXTExplorer", "location1"),
            -- Un .snippet peut utiliser toutes les API prises en charge par .xui
        },
        {  -- Sélecteur 3

        },
        -- ...
    };
    generator = function (...)  -- Générateur à arguments variables
        -- Traiter les paramètres et retourner le résultat produit
        local result
        return result
    end;
}

Niveau racine

Clé	Type	Description
name	string	Nom du snippet
description	string	Description du snippet
arguments	array	Liste des sélecteurs du snippet
generator	function	Générateur du snippet
output	string	Nom de fichier de sortie autonome du snippet

name et description sont respectivement le nom et la description affichés du modèle ; ils apparaissent dans le gestionnaire de fichiers et à l’entrée du snippet.

arguments est un tableau contenant un ou plusieurs dictionnaires de paramètres de sélecteur. L’application crée une file de sélection dans l’ordre défini par ce tableau et guide l’utilisateur étape par étape. Une fois la file terminée, elle transmet successivement les valeurs retournées par les sélecteurs comme arguments variables à generator, l’appelle, puis renvoie son résultat à l’appelant.

Un modèle .snippet peut être utilisé seul. Pour autoriser cette utilisation, définissez son champ output ; le texte produit par generator sera enregistré dans le fichier indiqué par output dans le même répertoire.

Dictionnaire de paramètres du sélecteur

Clé	Type	Description
type	string	Type de sélecteur
title	string	Titre du sélecteur, affiché en bas de sa page
subtitle	string	Sous-titre du sélecteur, affiché en bas de sa page
default	primitive	Valeur par défaut du sélecteur

Pour une présentation détaillée du dictionnaire de paramètres de chaque type de sélecteur, consultez les sections suivantes.

Utilisation dans XUI

Lorsqu’un modèle .snippet est utilisé dans le composant XUI TitleValue, la file de sélection peut être lancée depuis XUI et son résultat enregistré dans la configuration du composant. Le .snippet peut également appeler toutes les API prises en charge par XUI, comme xui.get/xui.set/xpp.bundle_path.

Utilisation dans l’éditeur de code

Placez le modèle .snippet dans le répertoire snippets du répertoire principal pour le rendre disponible dans l’éditeur de code de l’application. Touchez l’étoile en haut à droite de la barre d’outils du clavier pour générer rapidement un snippet et l’insérer dans le code en cours de modification.

Utilisation comme fichier autonome

Définissez le champ output du modèle .snippet et placez-le dans le répertoire lua/scripts du répertoire principal. Vous pourrez alors le toucher directement dans l’application pour lancer la file de sélection ; le texte produit par generator sera enregistré dans le fichier indiqué par output dans le même répertoire.