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

@pitaya-components/top-bar

v0.0.44

Published

Pitaya-Framework Component Top-Bar.

Downloads

19

Readme

Description

Topbars are a container for items such as application title, navigation icon, and action items.

Pitaya-framework template component.

This documentation assumes you are at least slightly familiar with aurelia and its usage. If not, we highly suggest you take a look at its Quick Start section first to get a better understanding of the approaches that are presented it here.

Screenshot

Screenshot

Demo

MDC Design & API Documentation

Installation

npm install @pitaya-components/topbar --save

Basic Usage

Via plugin (main.js)

Simple registration

You can register this component as an aurelia plugin. In that case you don´t have to do anything else.

export function configure( aurelia: Aurelia )
{
	aurelia.use.standardConfiguration()
		   .plugin( "@pitaya-components/topbar" )
		   .feature( "resources" );

	aurelia.start().then( () => aurelia.setRoot( "app/app", document.body ) );
}
With plugin configuration

You can optionally specify which sub components you will need and thus want to define to globally available.

import { PitayaTopbarConfiguration } from "@pitaya-components/topbar";

export function configure( aurelia: Aurelia )
{
	aurelia.use.standardConfiguration()
		   .plugin( "@pitaya-components/topbar", ( pluginConfig: PitayaTopbarConfiguration ) =>
		   {
			   pluginConfig.use(
				   "pitaya-topbar-row.html",
				   "pitaya-topbar-navigation.html",
				   "pitaya-topbar-actions.html",
				   "pitaya-topbar-action-icon.html"
			   );
		   } )
		   .feature( "resources" );

	aurelia.start().then( () => aurelia.setRoot( "app/app", document.body ) );
}

Import

If you don´t want this component to be handled as a plugin you have a few other options when importing a component into your layout:

Template
<template>
	<require from="@pitaya-components/topbar/dist/native-modules/pitaya-topbar"></require>
	<require from="@pitaya-components/topbar/dist/native-modules/pitaya-topbar-row.html"></require>
	<require from="@pitaya-components/topbar/dist/native-modules/pitaya-topbar-navigation.html"></require>
	<require from="@pitaya-components/topbar/dist/native-modules/pitaya-topbar-actions.html"></require>
	<require from="@pitaya-components/topbar/dist/native-modules/pitaya-topbar-action-icon.html"></require>
    ...
</template>
View model
@viewResources( 
	"@pitaya-components/topbar/dist/native-modules/pitaya-topbar",
	"@pitaya-components/topbar/dist/native-modules/pitaya-topbar-row.html", 
	"@pitaya-components/topbar/dist/native-modules/pitaya-topbar-navigation.html", 
	"@pitaya-components/topbar/dist/native-modules/pitaya-topbar-actions.html", 
	"@pitaya-components/topbar/dist/native-modules/pitaya-topbar-action-icon.html"
)
export class MyView
{
	...
}
Global resources
export function configure( config: FrameworkConfiguration )
{
	config.globalResources( [
		PLATFORM.moduleName( "@pitaya-components/master-component/dist/native-modules/master-component" )
	] );
}

Initialization

Our components are usually initialized by defining them in your views HTML. And can be accessed afterwards in the corresponding view model.

Template
<template>
	<pitaya-topbar
		view-model.ref="topbar"
		on-attached.call="doSomething(component)"
	></pitaya-topbar>
	...
</template>
View model
import {PiTopBar} from "@pitaya-components/topbar";

export class MyView
{
	public topbar: PiTopBar;

	public doSomething(component: PiTopBar)
	{
		this.topbar.type = "short";
	}
}

Variants

Default setup

<pitaya-topbar>
	<pitaya-topbar-row>
		<pitaya-topbar-navigation
			icon="manu"
			on-icon-click.call="openDrawer()"
			title="My Topbar Title"
		></pitaya-topbar-navigation>
		<pitaya-topbar-actions>
			<pitaya-topbar-action-icon
				icon="event"
				on-click.call="openCalendar()"
			></pitaya-topbar-action-icon>
			<pitaya-topbar-action-icon
				icon="more_vert"
				on-click.call="openMenu()"
			></pitaya-topbar-action-icon>
		</pitaya-topbar-actions>
	</pitaya-topbar-row>
</pitaya-topbar>

Event handlers

Attaching an event handler is as simple as adding on-<event>.call="<function>(<parameters>)".

NOTE: The function that you specify has to be defined as a method on the view model class, so that aurelias template engine can use it.

Template
<pitaya-topbar	
	on-navigation.call="topbarNavigated(event, component)"
	on-attached.call="topbarHasBeenAttached(component)"
>
	...
</pitaya-topbar>
View model
export class MyView
{
    public topbarNavigated(event: CustomEvent, component: PiTopBar)
    {
	    ...
    }

    public topbarHasBeenAttached(component: PiTopBar)
    {
	    ...
    }
}

You also can pass any parameter you like. Specifying event just tells the component that you wish to receive the event object, but if you define something else, it will be passed down to your function just like one would expect.

Template
<pitaya-topbar	
	on-attached.call="topbarHasBeenAttached('my custom message')"
>
	...
</pitaya-topbar>
View model
export class MyView
{
	public topbarHasBeenAttached(message: string)
	{
		...
	}
}

Bindables

A bindable is part of a core functionality of aurelia which basically allows you to configure a component from within your HTML code. They can be set/accessed via HTML attribute and also programmatically.

Template
<pitaya-topbar	
	type="dense"
>
...
</pitaya-topbar>
View model
import {PiTopBar} from "@pitaya-components/topbar";

export class MyView
{
	public topbar: PiTopBar;
	
	public someMethod()
	{
		this.topbar.type    = "prominent";
	}
}

Bindable properties

<pitaya-topbar>

| Attribute | Type | Description | --- | --- | --- | type | dense \| prominent \| short | Sets the type | on-attached | ( component: PiTopBar ) => void | Is called when the component is attached to the DOM | on-navigation | ( component: PiTopBar \| event: CustomEvent ) => void | Is called when the navigation icon has been clicked/tapped

<pitaya-topbar-navigation>

| Attribute | Type | Description | --- | --- | --- | icon | string | Sets the icon (material-icons) | onIconClick | ( event: CustomEvent ) => void | Is called when the navigation icon has been clicked/tapped | title | string | Sets the title

<pitaya-topbar-action-icon>

| Attribute | Type | Description | --- | --- | --- | icon | string | Sets the icon (material-icons) | onClick | ( event: CustomEvent ) => void | Is called when the action icon has been clicked/tapped

Methods and properties

PiTopBar

| Signature | Description | --- | --- | | container: Container | The components container object | type: dense \| prominent \| short | Sets the type | onAttached: ( component: PiTopBar ) => {} | Sets a callback that is called when the component is attached to the DOM | onNavigation: ( component: PiTopBar \| event ) => void | Sets a callback that is called when the navigation icon has been clicked/tapped | setScrollTarget( target: HTMLElement ) => void | | listen( eventName: TopbarEvent, handler: ( event?: CustomEvent ) => void, options?: AddEventListenerOptions ) => void | | unlisten( eventName: TopbarEvent, handler: ( event?: CustomEvent ) => void, options?: AddEventListenerOptions ) => void | | reinitialize( component \| event ) => void \| Promise< void > | Reinitializes the component

Style Customization

SASS mixins

With this component we are relying on the Top-App-Bar component of MDC. Check out the documentation to learn how to use their SASS mixins.

Note: SASS mixins are always applied on the main component <pitaya-topbar> by using the .pitaya-topbar selector.

Changes

The main repository uses tagged Releases to communicate changes between versions.

FAQ

Q: Why another JavaScript framework?
A: Read this article for a detailed overview of ours goals.

Reach Out!

Find us on Twitter for the latest news, and please consider giving us a ?? star on GitHub!

Support

For contributions in the form of bug fixes and changes, feel free to use Pull Requests or send us a DM on Twitter to discuss how best to approach your issue.

License

The Master component source code is licensed under the MIT license.