npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@vue-layout/basic

v1.1.0

Published

A package containing basic components, to build for example multi level navigation menus.

Downloads

6

Readme

@vue-layout/basic 🍙

npm version CI

A package containing basic components, to build for example multi level navigation menus.

Note The package is still in development and the API is still subject to change. Besides, the documentation still needs to be expanded

Table of Contents

Installation

$ npm i --save @vue-layout/basic

Usage

To use the navigation component, a constant must be defined, which satisfy the type: NavigationProvider.

The implementation will provide different navigation elements for each tier. The tier is a numeric value, which can reach from 0 to n (infinity).

module.ts

import {
    NavigationElement,
    NavigationProvider
} from "@vue-layout/basic";

const primaryItems : NavigationElement[] = [
    {
        name: 'Home',
        url: '/',
        icon: 'fa fa-home'
    },
    {
        name: 'About',
        url: '/about',
        icon: 'fa fa-info'
    }
]

export const navigationProvider : NavigationProvider = {
    async hasTier(tier: number): Promise<boolean> {
        // check if the tier exists.
        return Promise.resolve(tier === 1);
    },
    async getElements(tier: number, items: NavigationElement[]): Promise<NavigationElement[]> {
        // Return elements for a specific tier.
        // The context provides the current active elements for
        // the parent tiers.

        switch (tier) {
            case 0:
                return primaryItems;
            // ....
        }
    },
    async getElementsActive(url: string): Promise<NavigationElement[]> {
        // build element context for url
        if (url === '/') {
            return [
                primaryItems[0]
            ]
        }

        if (url === '/about') {
            return [
                primaryItems[1]
            ]
        }

        return undefined;
    }
};

The next step is to create the vue entrypoint.

index.ts

import {
    buildNavigation,
    createPlugin
} from '@vue-layout/basic';
import { createApp } from 'vue';
import { createRouter, createWebHistory } from 'vue-router';
import { navigationProvider } from './module';

const app = createApp();

app.use(createPlugin({
    navigationProvider
}));

const router = createRouter({
    history: createWebHistory(),
    routes: [
        /* ... */     
    ],
});
app.use(router);

(async () => {
    const url = router?.currentRoute?.value?.fullPath;
    await buildNavigation({ url });

    app.mount('#app');
})();

After those steps are completed, the NavigationComponents SFC can be placed anywhere, if registered globally.

<template>
    <div>
        <navigation-components :tier="0" />
        
        <navigation-components :tier="1" />
    </div>
</template>

Functions

buildNavigation

function buildNavigation(context?: NavigationBuildContext): Promise<void>

Build all navigation tiers, by url or active elements.

Example

URL

import { buildNavigation } from '@vue-layout/basic';

await buildNavigation({
    url: '/'
});

This will call the getElementsActive method of the NavigationProvider implementation, to calculate the active elements.

items

import { buildNavigation } from '@vue-layout/basic';

await buildNavigation({
    items: [
        {id: 'default', tier: 0, name: 'Home'}
    ]
})

This element array will be provided as second argument as context to the getElements method of the NavigationProvider implementation, to build a specific tier navigation.

buildNavigationWithRoute

function buildNavigationWithRoute(context?: Partial<NavigationBuildRouteContext>): Promise<void>

Build all navigation tiers, by route (url) or by interpreting the metaKey attribute of a route component.

Example

route

import { RouteLocation } from 'vue-router';
import { buildNavigationWithRoute } from '@vue-layout/basic';

const route : RouteLocation = {
    fullPath: '/',
    ...
};

await buildNavigationWithRoute({
    route
})

This method call is under the hood equal to: buildNavigation({url: '/'}).

metaKey

import { defineComponent } from 'vue';
import { buildNavigationWithRoute } from '@vue-layout/basic';

const metaKey = 'navigation';

const pageComponent = defineComponent({
    meta: {
        [metaKey]: [
            {id: 'default', tier: 0, name: 'Home'}
        ]
    },
    ...
});

await buildNavigationWithRoute({
    metaKey
})

This method call is under the hood equal to: buildNavigation({items: [{id: 'default', tier: 0, name: 'Home'}]}).

Types

NavigationBuildContext

import { Component } from '@vue-layout/basic';

type NavigationBuildContext = {
    items?: Component[],
    url?: string
};

NavigationBuildRouteContext

import { RouteLocationNormalized } from 'vue-router';

type NavigationBuildRouteContext = {
    route: RouteLocationNormalized,
    metaKey: string
};

NavigationElement

type NavigationElement = {
    id?: string | number,
    tier?: number,
    name?: string,

    url?: string,
    urlTarget?: '_self' | '_blank' | '_parent' | '_top' | string,

    default?: boolean,
    type?: 'separator' | 'link',

    icon?: string,
    environment?: 'development' | 'production' | 'testing',

    display?: boolean,
    displayChildren?: boolean,

    rootLink?: boolean,
    children?: NavigationElement[],

    requireLoggedIn?: boolean,
    requireLoggedOut?: boolean,
    requirePermissions?: string | string[] | ((checker: (name: string) => boolean) => boolean)


    [key: string]: any
};

NavigationProvider

import { NavigationElement } from '@vue-layout/basic';

declare type NavigationProvider = {
    getElements: (tier: number, items: NavigationElement[]) => Promise<NavigationElement[]>,
    getElementsActive: (url: string) => Promise<NavigationElement[]>,
    hasTier: (tier: number) => Promise<boolean>
};

Example

For an implementation example, on how to use this library, check out the example package.

License

Made with 💚

Published under MIT License.