Skip to content

Latest commit

 

History

History
177 lines (146 loc) · 7.67 KB

README.md

File metadata and controls

177 lines (146 loc) · 7.67 KB
Raw

rogue-components

What is this?

Rogue Components are a test bed/base templates for VUE3/VUETIFY3 components. In here I test client side vs server side component compilation and delivery to browsers. These base components represent a functional real world base that most admin sites need. The idea is to draw conclusions on the correct combination of client and server side tooling.

Rogue Templates expand on these base components by wrapping them in different combinations of server side templating and JS client side UX's as well as authorization, sessions, etc. Multiple langiuages and server side experiments.

Reasoning

I think vue has the best balanced reactive model. Sensible defaults and behavior. I also like the look of vuetify and appreciate their work so wanted to add some examples in hopes of increased adoption. I also wanted to converting my old 2.7 vue stuff to Vue 3.4.15 and Vuetify 3.2.47 (or greater).

Component general rules

  • This is all straight HTML to the Browser. Any and All compilation takes place in the browser.
  • To serve this just use nginx or apache and make a web root point to ./static (components and js) and ./html (HTML)
  • VUE3...Currently 3.4.15
  • VUETIFY3...Currently 3.5.2 (In particular the Labs v-data-table)
  • NO Typescript...Ok well sorta in default props...nothing intentional and only rely on vues client side ability.
  • NO Build...(Its already built(ish) just not chunked, dehydrated, and stirred)
  • NO SFC and SFC versions of the same components...
  • FULL MPA...cause I can
  • CDN where possible.
  • UMD Downloads and IIFE (Immediately Invoked Function Expression js library (e.g. it appends itsself to the window object if in a browser))
  • ECMA script type="importmap" and script type="module" usage where possible
  • EMACS Written entirely within emacs.
  • ROGUE..Some small creatures may have been harmed during the making of these. (mostly fish but dont ask)
  • MIXINS...yes but only because I havn't converted my mixins to composables and I'm not sure I want to.

DEPENDENCIES:

  1. my browser util code static/js/tmb.js (mostly harmless)
  2. [email protected] Sorry (not sorry).
  3. [email protected] for export of csv/pdf/excel functionality (cause I didnt want to mess with it)

Components

  • RcTable.js...a wrapper for v-data-table that adds a bunch of functionality. In particular:

    • Adds a RcTableToolbar that can have custom functions act on selected rows.
    • Allows custom row level filters, column level filters, and the search bar.
    • Allows export/download of table data to csv, pdf, excel.
    • Add remove optional columns.
    • Filters for array based fields as well as string and some date stuff.
    • Format values in columns.
    • Sensible multi select (select none, select all, invert selection)
    • Sensible sort with tooltips for all headers.
    • Totals lines

  • RcTableToolbar.js..used in RcTable. Holds row level filters, text search filter, oagination, reload button, select column button, export button, and custom buttons for actions based on selected items.

  • RcPagination.js..used in RcTableToolbar. A much more succinct pagination area than the default on v-data-table.

  • RcSelectMenu.js..used in RcTable. allows select all, none, invert and has a badge which shows count of selected items

  • RcColumnFilter.js..used in RcTable a dialog that lets you select filter criteria based on content of field (include or exclude)

  • RcBastardScroll.js..a little "scroll back to top" floating icon on bottom right that will scroll page to top. Only shows up if currently scrolled down.

  • RcTagsAddField.js..Lets you select tags and add a tag if it does not alread exist.

  • RcPhoneField.js..A sensible phone number input field...pattern based

  • RcPatternField.js..General purpose version of a phone field...somewhat helpful

  • RcNamedDaterange.js..Date range picker with some named ranges (for instance 'This Quarter')

Install

$ git clone https://github.com/crussell42/rogue-components.git

Directory layout

  • rogue-components/
    • html/index.html components test page
    • html/sfc-index.html sfc components test page
    • static/components...where the .js components live.
    • static/sfc-components...where the .vue components live.
    • static/js...where my ugly tmb tool code lives

So just run a nginx or apache or what ever and serve the html and static dirs. The test programs and components depend on relative urls: /static/components/*.js /static/js/tmb.js

Thats it, Clean-ish and simple.

Live preview (.js components)

https://aerospacey.io/demo/rogue-components/index.html

Live preview (.vue components)

https://aerospacey.io/demo/rogue-components/sfc-index.html

Screen Grabs

Screenshot at 2024-02-07 15-29-36

Observations: Vue 2.6 to Vue 3 and Vuetify2 to Vuetify3

  • In general I have been able to convert my ver 2 stuff to ver 3 mostly by ignoring composition at first then refactoring later.
  • I think having straight named object components has simplified things. Example DogComponent.js: 
    
import {ref, reactive, mergeProps} from 'vue'
export const DogComponent = {
    components: {
    },
    props: {
        name: {type:String, default:'Stinker'},
        age: {type: Number, default: 6},
    },
    setup(props,context) {
        const localName = ref(props.name);
        return {
            localName,
        }
    },
    data: function() {
        return {
            
        }
    },
    computed: {
        localName: {
            get: function() {
                return this.name;
            },
            set: function(val) {
                this.$emit('update:name',val);
            }
        } 
    },
    methods: {
        mergeProps,
        bark() {
            console.log('Ruff');
        },
    },
    template: `
        <div>Hello {{localName}} who is {{age}}</div>
    `
}
  • Slot changes in vuetify have caused the most greif.
    • v-data-table v-slot:header. is now column.
    • v-data-table v-slot:body.append is gone.
    • v-bind, v-on merged now v-bind=mergeProps(menu,tooltip) (import mergeProps from vue)
    • activator now v-slot:activator="{props: menu}
    • align="right" is now align="end",
    • density="compact" rather than small or x-small.
    • Changed default color scheme to something funky purple and green

The 'EUE' style...(pronounced Eeeewwww)

Originated from ejs server side templating in node with vue as UI. The EUE style may fall outside of the standard accepted and sterile standards of the day, but work and are in fact used in active projects although mostly in internal projects. May include ugly server side templating in ejs, django, etc. If you dont fully drink the koolaid of micro services, typescript, obfuscation, chunking, hydration, treeshaking, spas and amorphous programming; these components may be for you. -Or-, if you actually just need to get something done or want an easy to read and understandable source they may be for you.

DELIMITERS AND DJANGO

If you see a delimiters statement on a vue instance in here it is because django forces {{}} and make it really hard to change. So when I'm doing django,vue app I change the delimiters on Vue cause its easier.

Sample nginx configuration to run the component test page.

The html dir and static dir must be served. Use nginx alias to achieve this.


server {
	listen 80;
	listen [::]:80;

	server_name roxy 192.168.1.12;

	root /home/chris/rogue-components/html;
	index index.html;

	location /static/ {
	        alias /home/chris/rogue-components/static/;	
	}
	location / {
		try_files $uri $uri/ =404;
	}
	
}