1.0.0 • Published 1 year ago

sheets_form_builder_js v1.0.0

Weekly downloads
-
License
-
Repository
github
Last release
1 year ago

Instalación

npm install sheets_form_builder_js

Integracion

...
import FormBuilder from 'sheets_form_builder_js';
import 'sheets_form_builder_js/src/sass/app.scss';

const store = new Vuex.Store({}); // o incluir store ya existente 
Vue.use(FormBuilder_js, { store: store});

const app = new Vue({
    el: '#sheets_form_builder',
    store
});

Integración de forma programatica

const FormBuilderClass = Vue.extend(FormBuilder);

const instance = new FormBuilderClass({
    propsData: {
        id: 'FORM ID',
        record: 'RECORD ID',
        base_url: 'http://url',
    },
    store: this.$store,
});

instance.$on('loading', (value) => {
    this.loading = value;
});

instance.$on('formHasBeenRenderer', (value) => {
    this.formHasBeenRenderer = value;
});
instance.$on('input', (value) => {
    this.data = value;
});

instance.$mount();
this.$refs.fb.appendChild(instance.$el);

Para mayor informacion sobre los eventos del formbuilder leer la documentación

docs/formbuilder.md

Generación de documentacion

Ya existe un comando con la capacidad de generar la documentación.

npm run doc

Para esto, el desarrollador debe tener previamente instalado el paquete vuedoc-md.

La forma de escritura debe ser según JSDOC

TODO

  • Continuar refactorizacion entre los mixins, dada la existencia de redundacia de propiedades y metodos, principalmente:
    • Input
    • Selectores
    • Archivos
  • Implementación de encuestas, preferiblemente realizarlo en un componente/lib separado
  • Ampliación de los eventos propios de FormBuilder
  • Ampliar la documentacion de los componentes
  • Escritura de pruebas unitarias
  • Escritura de pruebas funcionales
  • Mejoras de temas css (Themes) y asignacion mediante el instalador (src/install.js)
  • Incluir documentacion del instalador y pruebas unitarias/funcionales