@mesg-components/footer

1.1.0 • Public • Published

@MESG-COMPONENTS/FOOTER

Install

npm install @mesg-components/footer or yarn add @mesg-components/footer

Properties

  • banner: String, Required, -> banner to display on the footer
  • categories: Array of string, Required. Example ["xxx","xxx","xxx",...], -> Display items on each category values
  • items: Array of object, Required, -> items to display on the footer
  • copyright: String, Optional, -> copyright to display on the footer
  • policy: Object, Optional, -> policy to display on the footer
  • icons: Array of object, Optional, -> icon class and link path

Slot

  • define each slot name using items_key exists on categories

Example

const image = '../image.svg'
const categories = ['1', '2', '3', '4']
const copyright = '© 2019 My Copyright'
const policy = { text: 'Privacy & Cookie Policy', link: 'https://.../...' }
const icons = [
  { to: 'https://medium.com/...', classIcon: 'fab fa-medium' },
  { to: 'https://github.com/...', classIcon: 'fab fa-github' },
  ...
]
const items = [
  {
    key: '1',
    text: 'Title 1',
    child: [{ id: '1', text: 'xxx', to: '/..' },{ id: '2', text: 'xxx', to: '/path' },]
  },
  { key: '2', text: 'Title 2', to: 'http://.../xxx' },
  {
    key: '3',
    text: 'Title 3',
    child: [{ id: '3', text: 'xxx', to: '/12' },{ id: '4', text: 'xxx', to: 'https://medium.com/...' }]
  }
]

Default:

<template>
  <footer :banner="banner" :copyright="copyRightText" :items="items" :policy="policyText" :categories="categories" :icons="icons">

    <template v-slot:1="{ item }">
      <h1 style="margin: 0">{{item.text}}</h1>
      <ul>
        <li v-for="(child, i) in item.child" :key="i">
          <a :href="child.to">{{child.title}}</a>
        </li>
      </ul>
    </template>

    <template v-slot:2="{ item }">
      <a :href="item.to">
        <h1 style="margin: 0">{{item.text}}</h1>
      </a>

    <template v-slot:3="{ item }">
      <h1 style="margin: 0">{{item.text}}</h1>
      <ul>
        <li v-for="(child, i) in item.child" :key="i">
          <a :href="child.to">{{child.text}}</a>
        </li>
      </ul>
    </template>
  </footer>
</template>

Readme

Keywords

none

Package Sidebar

Install

npm i @mesg-components/footer

Weekly Downloads

0

Version

1.1.0

License

none

Unpacked Size

7.46 kB

Total Files

6

Last publish

Collaborators

  • nicolasmahe
  • anthony-mesg
  • nicolas-mesg