Git Product home page Git Product logo

kbar-angular's Introduction

kbar

Angular library inspired by kbar React library

Provides plug-n-play tool for efficient navigation on your website.

Features

todo

Usage

npm i kbar-angular
  • Add KbarAngularModule to app.module.ts to imports array

  • to access components service, add KbarAngularService to providers array

component class

actions = [
  {
    name: "Home",
    keywords: ["home"],
    perform: () => {
      document.location.href = "/";
    },
  },
  {
    name: "Console.log",
    keywords: ["log", "console"],
    perform: () => {
      console.log("Hello world!");
    },
  },
];

component template

<kbar [actions]="actions">
  <kbar-overlay />

  <kbar-positioner>
    <kbar-search></kbar-search>
    <kbar-results></kbar-results>
  </kbar-positioner>
</kbar>

Development

  • install dependencies and make sure you're using correct node version
    nvm use
    npm i
  • build library npm run lib:build
  • build library in watch mode ng build kbar-angular --watch
  • run the documentation page npm run example:start

kbar-angular's People

Contributors

krystxf avatar

Stargazers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.