Comment créer un plug-in

1. Créer un fichier script-name.vue.

2. Ajoutez du contenu au fichier comme ci-dessous:

<!--
PluginName: __SCRIPT_NAME__
PluginUrl: __URL_WHERE_OTHER_USERS_CAN_DOWNLOAD_THE_SCRIPT__
-->


<!-- Libraries (if need) -->
<script src="__URL_OF_LIBRARY_JS_FILE__"></script>


<!-- Main Script -->
<script>

// On Key Down
ioctopus.$on("keydown", e => {

	// Alt + Shift + N
	if (e.altKey && e.shiftKey && e.code === "KeyN") {

		// Get Selected Branches
		const selectedBranches = ioctopus.getSelectedBranches();

		// Each branches
		for (let branch of selectedBranches) {

			// Change the branch content
			let text = branch.getText();
			
			// Change the text as you want
			// (you can use html)...
			text = `<span class="my-style">${text}</span>`;

			branch.setText(text);
		}
	}
});
</script>


<!-- Styles -->
<style>
.my-style {
	color: green;
}
</style>

ioctopus - est l objet principal de la carte mentale

Principaux événements

ioctopus.$on('EVENT_NAME', callback);

Événements disponibles:

  • keydown
  • keypress
  • keyup
  • context-menu
  • branch-map-data (lors de la modification des données de la branche)

Menu contextuel

// On Context Menu
ioctopus.$on('context-menu', contextMenu => {

	// Add to the Context Menu new Button
	contextMenu.add({
		label: "Button text", // Button Text
		icon: "fas fa-list-ul", // Button Icon
		keycode: "Alt+Shift+L", // Dysplayed prompt
		click: () => { // Button action
			// Code running on click
		},
		href: "https://...", // Button url (when no Button action)
		target: "_blank", // Open Button url in new window (tab)
	});
});

Où puis-je obtenir des icônes?

De fontawesome.com.
Par exemple, copiez ce code depuis cette page.

Branches

Obtenir la branche par id :

const branch = ioctopus.getBranchById(ID);

Obtenez les branches sélectionnées :

const selectedBranches = ioctopus.getSelectedBranches();

Obtenir le texte d une branche : Définir le texte d'une branche : Ajouter une branche enfant :
branch.addChild({
	content: {
		text: "My new branch",
	}
});

Afficher/masquer la branche "Chargement..."

branch.loading();
branch.loadingStop();

Ajouter un bouton à la branche :

branch.addButton('buttonName', {
	icon: 'fa-equals fas',
	title: 'Title on hover',
	label: 'Button label',
	click: () => {
		console.log('Button pressed')
	},
})

Où puis-je obtenir des icônes ?

From fontawesome.com.
Par exemple, copiez ce code depuis cette page.

Supprimer le bouton

branch.removeButton('buttonName')

Lorsque les données de branches sont modifiées

ioctopus.$on('branch-map-data', ({ $branch, mapData }) => {
	// ...
});

Sélection

Nombre d éléments sélectionnés :

ioctopus.selectedCount

Éléments sélectionnés

let selectedElementsArray = ioctopus.getSelected();

Choisir des éléments

Pour donner à vos utilisateurs la possibilité de choisir une branche, utilisez suivant :

Lancez le mode de sélection :

ioctopus.startPicking($branch => {
	ioctopus.stopPicking();
	console.log('$branch', $branch);
});

Arrêtez de choisir :

ioctopus.stopPicking();

Barre de menu

Comment ajouter un bouton à la barre de menu :

// Menubar
ioctopus.addButtonToMenubar({
	to: 'tools',
	button: {
		label: 'Button label',
		icon: 'fas fa-calendar-alt', // Font Awesome
		click() {
			// ...
		},
	},
});

Dialogues

Ouvrez le dialogue :

ioctopus.openDialog({
	header: 'Header of dialog',

	// Vue Component
	component: {
		template: `<p>Content</p>`,
	}

}).then(dialog => {
	//...
});

Fermer le dialogue

dialog.close();

Désactiver les Shortcodes sur un champ de texte

Après avoir mis au point une entrée :

ioctopus.onFocus();

Après avoir retiré le focus du champ :

ioctopus.onBlur();

Exemple :

ioctopus.openDialog({
	header: 'Header of dialog',

	// Vue Component
	component: {
		methods: {
			
			onFocus() {
				ioctopus.onFocus();
			},


			onBlur() {
				ioctopus.onBlur();
			},
		},
		template: `<input @focus="onFocus" @blur="onBlur">`,
	}

});

Enregistrer le fichier

ioctopus.save();

Voulez-vous plus de fonctionnalités?

Envoyez-nous un courriel à roman@ioctopus.online.

Commentaires