Skip to content

geneontology/wc-web-gocam

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 

Repository files navigation

GOCam Browser Components

This is repo for GOCam browser and its related components

GH folder Description Component Docs NPM package
wc-gocam-table GO Cam Browser docs @geneontology/wc-gocam-table
wc-goc-paginator GO Cam Browser docs @geneontology/wc-goc-paginator

Demo

Demo can be found here

Examples

This is the basic example of integrating the GOCam browser table'

The table can work well with a separate pagination component.

In case some use case want to put pagination at the top and bottom of the table. This is an example of how to sync multiple pagination. Note: make sure pagination class in included in table attr pagination-class

For the Developers

To start building a new web component using Stencil, clone this repo to a new directory:

git clone https://github.com/ionic-team/stencil-component-starter.git wc-gocam-table
cd wc-gocam-table
git remote rm origin

and run:

npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Need help? Check out our docs here.

Naming Components

When creating new component tags, we recommend not using stencil in the component name (ex: <stencil-datepicker>). This is because the generated component has little to nothing to do with Stencil; it's just a web component!

Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix ion.

Using this component

There are three strategies we recommend for using web components built with Stencil.

The first step for all three of these strategies is to publish to NPM.

Script tag

  • Put a script tag similar to this <script src='https://unpkg.com/wc-gocam-table@0.0.1/dist/wc-gocam-table.esm.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

Node Modules

  • Run npm install wc-gocam-table --save
  • Put a script tag similar to this <script src='node_modules/wc-gocam-table/dist/wc-gocam-table.esm.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

  • Run npm install wc-gocam-table --save
  • Add an import to the npm packages import wc-gocam-table;
  • Then you can use the element anywhere in your template, JSX, html etc

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published