Bien débuter

Créer un nouveau projet

Si vous souhaitez démarrer un nouveau projet de zéro vous pouvez utiliser Orion CLI pour amorcer un nouveau projet propre.
Rendez-vous dans la section Créer un nouveau projet de la page d'installation.

Installation dans un projet existant

Si n'êtes pas familier avec npm vous pouvez vous référer à la page d'installation.
Si vous souhaitez installer Orion dans un projet existant, suivi le guide ci-dessous.

npm install --save @orion.ui/orion

Full library

import { createApp } from 'vue';
import App from './App.vue';

import Orion from '@orion.ui/orion'; // Import de la librairie
import '@orion.ui/orion/dist/style.css'; // Import des styles
import '@orion.ui/orion/dist/monkey-patching'; // Import du fichier de définition du Monkey Patching

createApp(App).use(Orion).mount('#app');

With options

import { createApp } from 'vue';
import App from './App.vue';

import Orion from '@orion.ui/orion'; // Import de la librairie
import '@orion.ui/orion/dist/style.css'; // Import des styles

createApp(App)
  .use(Orion, {
		prefix: 'abc',
    use: ['components'], // Le Monkey Patching ne sera pas utilisé ici
    lang: 'fr',
  } as Orion.Config)
  .mount('#app')

Options de configuration

Orion fournit des options de configuration lorsqu'il est utilisé dans votre application.
Ces options sont du type Orion.Config, décrit ci-dessous :

// Type definition
type Orion.Config = {
	prefix?: string
	use?: ("components" | "monkeyPatching")[]
	lang?: LangAvailable
	router?: Router
}

prefixstring : 'o'

Il s'agit du préfix qui va se placer avant le nom des composants au niveau du template.
Par exemple si vous définissez 'abc', dans votre template <o-button> sera <abc-button>.

use('components' | 'monkeyPatching')[] : ['components', 'monkeyPatching']

Il est possible d'utiliser uniquement les composants, ou juste le Monkey patching (plus d'infos), ou les deux, ce qui est le comportement par défaut.

lang'en' | 'fr' : 'en'

Pour le moment des traductions en anglais et en français sont disponibles

routerRouter : undefined

L'instance de VueRouter de votre application, si vous utilisé les composant OrionLayout ou de navigation (OrionNavMain, OrionNavTop, OrionNavTab)