@purtuga/project-showcase

Project Showcase

Quickly add showcases to your library and provide the ability to generate a static site for them.

Each showcase is added by calling the showcase() function with a callback that is called when that showcase is selected in the UI.

This library provides a set of Custom Elements that can be used to build the User Interfaces that then displays the showcases that were registered.

Install

$ npm i purtuga/project-showcase

To setup showcase on the project where it was just installed, run:

$ node ./node_modules/.bin/project-showcase-setup

This will create a folder named shocase at the root of the project. It will also do some dev setup if a folder named my.dev exists (project-base normally sets this up).

Dev setups

Once the project is setup for a showcase, adding the following script to your package.json may be desired:

{
    script: {
        "setup:dev:showcase": "node node_modules/project-showcase/scripts/create-dev"
    }
}

This will setup the my.dev folder to pickup showcases in dev mode.

Provided Methods/Elements

showcase() method

Registers a showcase.

import {showcase} from "showcase"

showcase("cool-button", function ($content){
    // build showcase
    
    $content.appendChild(showcaseNode);
    
    $content.onDestroy(() => {
        // clean up if needed when showcase is destroyed
    });
})

TODO: document method's signature/usage.

Element: showcase-menu

UI element will display the menu with all registered showcases.

<showcase-menu></showcase-menu>

This element emits the following events:

• show : the showcase to display

Element: showcase-router

UI element that will initialize a page hash router. The router in turn updates the internal state by first clearing out the current state.selected showcase and then populating it with the new one that was selected.

Element: showcase-body

The UI element where the showcase should be displayed in. Will be given to the callback function provided to showcase() method.

<showcase-body></showcase-body>

This element has one required prop named showcase and it must be an object with the showcase information. (note: this is a "prop" not an html attribute).

Element: showcase-test-runner

The UI element where Unit Test Cases can be run from the browser.

<showcase-test-runner
    tests=[]
    auto-run?
    ></showcase-test-runner>

The Element accepts a tests prop (Array<String>) with a list of test files that should be loaded adn ran. These will be run in an iframe setup with Mocha, Chai and Sinon (different test harnesses possible in the future).

TODO

• [x] Create script that allows this to be added to any existing project
• [ ] Enhance showcase() function api
• [ ] Create prettier app template
• [ ] Create better menu system