flexified v1.0.8

Flexified

Flexified is a simple TypeScript-based library that helps you generate a CSS flexbox-based square grid.

Installation:

npm install flexified

Usage:

Import the library and CSS:

import Flexified from 'flexified'
import 'flexified/src/styles.css'

Add the next css classes to your layout:

• flexified-wrapper: applied to your flexbox container
• flexified-child: applied to your flexbox children

See the example below for implementation.

Methods:

Currently, Flexified has one static method called getClassNames.

This method returns a string array with a list of classes you will apply to your flexbox container.

Options:

getClassNames allows the next options:

• itemCount - the number of items in your flexbox container - Required

• mobileWidthThreshold (default: 768) - the window width from which the mobile layout will be enabled - Optional

CSS Customization:

The CSS allows to customize the padding between the flexbox children.

Use the var --flexified-padding in order to change the padding between the flexbox children.

Example:

Vue.js component

<template>
  <div
    class="flexified-wrapper"
    :class="classList"
    :style="'--flexified-padding:' + padding + 'px'"
  >
    <div class="flexified-item" v-for="n in itemCount" :key="n" />
  </div>
</template>

<script lang="ts">
import Vue from 'vue';
import Flexified from 'flexified';
import 'flexified/src/styles.scss';

export default Vue.extend({
  name: 'Flexified',
  data: function() {
    return {
      mobileWidthThreshold: 768, // Optional
      itemCount: 8, // Reflect the number of children
      padding: 14,
      classList: ['']
    }
  },
  methods: {
    getClassList(): {
      this.classList = Flexified.getClassNames({itemCount: this.itemCount, mobileWidthThreshold: this.mobileWidthThreshold})
    },
    onResize(): {
      this.getClassList() 
    }
  },
  mounted() {
    this.getClassList() // Initialize the flexbox styles
    window.addEventListener('resize', this.onResize) // Update the flexbox on resize to allow responsivness
  }
});
</script>