@dlazar/polaris-view-components NPM

Polaris ViewComponents

Polaris ViewComponents is an implementation of the Polaris Design System using ViewComponent.

Polaris ViewComponents

This library is under active development. Breaking changes are likely until stable release.

Preview

Usage

Render Polaris ViewComponents:

<%= polaris_card(title: "Title") do %>
  <p>Card example</p>
<% end %>

Installation

In Gemfile, add:

gem 'polaris_view_components'

Run install generator:

rails generate polaris_view_components:install

Setup Polaris styles in your layouts <head> tag:

<%= stylesheet_link_tag 'polaris_view_components' %>

Define Polaris style on your <body> tag:

<body style="<%= polaris_body_styles %>">

Importmaps

Install dependencies:

bin/importmap pin @rails/request.js --download

If you use sprockets make sure the vendor folder is loaded in app/assets/config/manifest.js:

//= link_tree ../../../vendor/assets/javascripts .js

Add to config/importmap.rb:

pin "polaris-view-components", to: "polaris_view_components.js"

Add to app/javascript/controllers/index.js:

// ...

import { registerPolarisControllers } from "polaris-view-components"
registerPolarisControllers(Stimulus)

NPM

Install NPM package:

yarn add polaris-view-components @rails/request.js

Add to app/javascript/controllers/index.js:

// ...

import { registerPolarisControllers } from "polaris-view-components"
registerPolarisControllers(Stimulus)

Dependencies

In addition to the dependencies declared in the gemspec, Polaris ViewComponents assumes the presence of Polaris CSS.

Development

To get started:

Run: bundle install
Run: bin/dev

It will open demo app with component previews on localhost:4000. You can change components and they will be updated on page reload. Component previews located in demo/test/components/previews.

To release gem run:

script/release

To release npm package run:

yarn release

License

The gem is available as open source under the terms of the MIT License.

@hotwired/stimulus @rails/request.js

@everything-registry/sub-chunk-247 @infinitebrahmanuniverse/nolb-_dl

0.9.1

2 years ago