ni / ni/nimble

Workflows for optimized blazor builds for nimble and spright

Open
#558 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discussion enhancement
Dominant language
TypeScript
Stars
39
Forks
14
Avg merge
1d 16h
Merged PRs (30d)
13

Description

📌 User Story

Split off from #440

There's a few ways that clients may want to utilize Nimble in Blazor apps that are advanced/ we don't think will be common.

  • Pull in source from CDN Do we actually want clients to do this? The nimble-components Readme already covers getting the Nimble bundle via unpkg, but the JS bundle (all-components-bundle.min.js) is equivalent to the one already included in the Nimble Blazor NuGet, so I don't think we actually need to document/suggest this.
  • Manually pull in files of interest by using npm directly and a bundler
  • Better workflow of including SCSS files (include them in the Nimble Blazor NuGet, switch tokens SCSS to use @use, use sass npm package so we can import the tokens SCSS via node_module resolution, ...)

For the above points, we think the suggested workflow will be to add a package.json to the consuming Blazor project, have it add a dependency on nimble-tokens, potentially sass, and a bundler package like Parcel or Webpack, and then probably adding some npm build commands as part of the Blazor project build.

We think we can defer this in the short term.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the split-off context in issue #440 and the nimble-components README section on static-page prototyping. Investigate the proposed package.json workflow, nimble-tokens and optional sass dependency, plus Parcel or Webpack bundling for Blazor consumers. Done would mean an agreed, documented workflow for the advanced build cases, but the issue currently defers this work.

Written by the indexing model from the issue text.

Assessment

Tech stack
sass, scss, webpack
Domain
build-system, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.