Code Monkey home page Code Monkey logo

comp-lib-test's Introduction

Bulma React

Atomic React/TypeScript components for Bulma v0.9.3. Useful for type-safe implementations of the Bulma CSS Framework.

To Install

As this will be a privately hosted npm package, there is some setup required before you are able to access this package directly from your project.

Until internal private servers are set up and configured, you will act as your own private npm registry locally. Fortunately, set up is easy!

  1. Clone this git repository locally to your machine.
  2. Globally install Verdaccio, a private proxy registry:
    1. npm install --global verdaccio
  3. From the command prompt, run the following command to start your private proxy registry
    1. verdaccio
  4. It will be running on http://localhost:4873
  5. Navigate to the root directory of your local version of the repository and run the following script:
    1. npm run local-publish
    2. If necessary, create a local user to sign in as before the local-publish.

You now have a private registry running on your local machine and have successfully published the library to it.

In order to use your locally hosted npm package, we need to utilize the ---registry flag when performing an npm install to tell npm where to look for our package.

  1. Navigate to your project directory where you'd like to use this component library.
  2. Run the following command:
    1. npm install bulma-react --registry http://localhost:4873

You should now be ready to use Bulma React!

Documentation

There is currently no Storybook documentation for this project.

All of these Bulma components are wrappers around the CSS styles and therefore this library's effectiveness will be maximized if the developer follows the CSS layout rules outlined in the Bulma documentation. Usage inconsistent with the described documentation may result in weird behavior.

To Use

import React from "react";
import "bulma/css/bulma.min.css";
import { Button } from "bulma-react";

export default () => (
  <Button
    color="is-primary"
    size="is-large"
    isRounded
    onClick={() => alert("I clicked a Bulma Button")}
  >
    My Bulma Button
  </Button>
);

comp-lib-test's People

Contributors

zprobinson avatar

Stargazers

 avatar

Watchers

 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.