Git Product home page Git Product logo

fvtt-component-pouch's Introduction

Component Pouch

Every wizard needs a component pouch -- Web Components for your Foundry VTT modules and systems!

Installation

todo

Usage

Once installed, your components will be available anywhere where you can write HTML -- even in your Handlebars templates. You can also find them on window.COMPONENTPOUCH if you need to extend or make changes to anything.

Using a component is pretty easy:

<section class="some-character-sheet-section">
  <pouch-accordion>
    <pouch-accordion-item title="Stats">
      Components that can accept slotted content, like `pouch-accordion-item`, can accept arbitrary text
    </pouch-accordion-item>
    <pouch-accordion-item title="equipment">
      <p>They can also</p>
      <ul>
        <li>accept</li>
        <li>html</li>
        <li>content</li>
      </ul>
    </pouch-accordion-item>
  </pouch-accordion>
</section>

Component List

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Development

This repository uses Lerna to manage packages and dependencies. After cloning this repository, you can get started by running the following from the repo root:

npm install
npx lerna bootstrap
npx lerna run storybook

This will install the root project dependencies, install child dependencies (including packages we have defined ourselves through Lerna), and start the Storybook server. Afterwards, you can copy one of the existing folders in packages to create your own component (or, if you have lerna-wizard, you can use that to create a new package!)

Building

With all dependencies installed, run npm run build to build the bundle, in both expanded and minified variants.

License

MIT

fvtt-component-pouch's People

Contributors

wyrmisis avatar

Watchers

 avatar

fvtt-component-pouch's Issues

Filterable List

Summary

The Filterable List will, given a list of data, display a list and an input field to the UI. The input field will filter the list based on content, and the filter will be case-insensitive.

Open Questions

  • Should there be an option for case-sensitive filtering?
  • Should list data be populated with a JS object or a series of <li /> tags?

Add an introductory page to the Storybook

Right now, our Storybook just jumps right into the components. I think it would be helpful if we took the content from /README.md and added it to the Storybook, as well.

Filterable Table

Summary

The Filterable Table component will act as a "smarter" replacement for standard HTML tables.

Open Questions

  • There are a few ways to go about organizing the data for this:
    • Across multiple attributes (one for headings, one for data, one for options, using the same key to unify all of them
    • Across one big object (less desirable, since I see the table header and options fields as optional)

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.