Feature: Add The Ability To Hide Viewall Links #1034

sghoweri · 2019-08-01T01:14:04Z

Summary

Adds the ability to hide any viewall links that would normally show up in the Pattern Lab navigation.

Details

Updates the Webpack build config + .patternlabrc config to support a new noViewAll config option when customizing Pattern Lab's UI.

Before vs After

How To Test

Pull down this branch and install NPM dependencies by running npm run setup.
Go to the packages/edition-twig folder and uncomment line 5 in the example .patternlabrc config file.

module.exports = {
  buildDir: __dirname + '/public',
  wwwDir: __dirname + '/public/',
  publicPath: '/public/styleguide/',
  // noViewAll: true, // <!-- uncomment this line
};

Rebuild Pattern Lab's UI by running npm run build:uikit from the same packages/edition-twig folder
Confirm the regenerated UIKit is rendering properly by now running npm run serve

…igation

jryanconklin · 2019-08-16T22:59:36Z

Just a note to say I'd really love to have this.

bmuenzenmeyer · 2019-08-20T06:08:40Z

@sghoweri can i switch this target to dev ?

sghoweri · 2019-08-20T06:19:18Z

@bmuenzenmeyer go for it!

bmuenzenmeyer

playing catchup on this feature - it is not accessible from a patternlab-config.json entry, correct? ony at build time from the uikit?

EDIT:

looking at that edition for the first time - adding build:uikit is an interesting end-user customization feature! 👍

$INIT_CWD is not cross-platform safe - going to try cross-env

bmuenzenmeyer · 2019-08-23T15:27:16Z

packages/uikit-workshop/.patternlabrc.example.js

@@ -2,4 +2,5 @@

 module.exports = {
  // buildDir: __dirname + '/www/pattern-lab',
+  noViewAll: true, // uncomment to disable displaying viewAll links in Pattern Lab


this comment doesnt make sense, as it's enabled, not commented

Derp — I think I was thinking we’d want this option to be disabled by default (hence the comment) but I probably I uncommented that when I was putting together my PR screenshot 🤦‍♂️

sghoweri · 2019-08-23T17:17:55Z

playing catchup on this feature - it is not accessible from a patternlab-config.json entry, correct? ony at build time from the uikit?

EDIT:

looking at that edition for the first time - adding build:uikit is an interesting end-user customization feature! 👍

$INIT_CWD is not cross-platform safe - going to try cross-env

@bmuenzenmeyer yeah customizing / extending PL is an exciting area I’m hoping to spend some time planning out / documenting / building up!

At a high level, I’m thinking about 3 overall ways PL’s UI could get customized:

Via runtime / JSON config (patternlab-config.json) not requiring the UI to recompile
Via patternlabrc.js (requiring UI to get rebuilt, say via the CLI)
And declaratively via customizing the web component HTML getting used

bmuenzenmeyer · 2019-10-11T17:41:56Z

@sghoweri can you change this to use cross-env? otherwise I can try quick

it'd be nice to batch this in to the release (I hope we release today)

sghoweri · 2019-10-11T17:43:06Z

@bmuenzenmeyer I can check this out now - no prob

…into feature/no-viewall-links

bmuenzenmeyer · 2019-10-11T17:57:06Z

I am going to try to get this working on Windows then.

bmuenzenmeyer · 2019-10-11T18:03:39Z

Also like to get this into development-edition-engine-handlebars for now

bmuenzenmeyer · 2019-10-11T18:12:27Z

trying to work through this

Error: ENOENT: no such file or directory, open 'D:\src\patternlab-node\packages\development-edition-engine-handlebars\node_modules\@pattern-lab\uikit-workshop\$INIT_CWD\.patternlabrc.js'

bmuenzenmeyer · 2019-10-11T18:15:56Z

this works!?

"build:uikit": "npm run build --prefix node_modules/@pattern-lab/uikit-workshop -- --patternlabrc ../../../.patternlabrc.js",
```

bmuenzenmeyer · 2019-10-11T18:23:16Z

I am still seeing the pattern type view all, but sub type appears gone

does this seem right @sghoweri

sghoweri · 2019-10-11T18:27:29Z

Hmmm

bmuenzenmeyer · 2019-10-11T18:30:34Z

changing noViewAll seems to have no effect for me within my codebase

bmuenzenmeyer · 2019-10-11T18:33:04Z

pushed https://github.com/pattern-lab/patternlab-node/tree/1034-test

npm run setup
cd packages/development-edition-engine-handlebars
change `noViewAll` within `.patternlabrc.js`
npm run build:uikit
npm run pl:serve

bmuenzenmeyer · 2019-10-11T18:36:30Z

@sghoweri game to release dev as is and figure this out as a fast-follower?

sghoweri · 2019-10-11T18:47:11Z

@sghoweri game to release dev as is and figure this out as a fast-follower?

@bmuenzenmeyer I'm good with that!

bmuenzenmeyer · 2019-10-22T15:15:19Z

@sghoweri just checking in on this - very excited for the functionality but i want to ensure it works in both Twig and Handlebars editions before we move forward. will try again after a dev upstream merge sometime soon

bmuenzenmeyer · 2019-11-22T19:06:16Z

once this merge conflict is resolved, I am hoping that #1098 will immensely help iterate on this solution

bmuenzenmeyer · 2019-11-23T04:27:52Z

tracking this work in https://github.com/pattern-lab/patternlab-node/tree/sghoweri-feature/no-viewall-links

bmuenzenmeyer · 2019-11-23T07:03:21Z

i've spent a fair amount of time with this and cannot get it to work - i wonder now that we have the build-tools.js file if parts of that could be used.

@sghoweri you've also expressed concern that this might not be the best approach. thoughts on making this a runtime config option?

sghoweri · 2019-11-23T13:07:41Z

i've spent a fair amount of time with this and cannot get it to work - i wonder now that we have the build-tools.js file if parts of that could be used.

@sghoweri you've also expressed concern that this might not be the best approach. thoughts on making this a runtime config option?

@bmuenzenmeyer no worries, appreciate you taking a look at this.

I'm looking this over this morning (probably trying to switch to using a runtime config out of simplicity); I'll see what I can do!

bmuenzenmeyer · 2019-11-23T13:47:40Z

It's entirely possible I'm either doing something wrong (though I was porting the twig edition code directly) or the is a simple cross platform fix... but I haven't found it yet.

Thanks for plugging away on this with me!

… the updated (optional) noViewAll config

…ed issues with pattern keys not always matching up with the3 generated navigation / query string

sghoweri · 2019-11-23T16:47:51Z

@bmuenzenmeyer this should be good to go! Updated the PR description + adjusted some stuff internally to now have this be based off of the runtime config vs having to recompile the UI in order to enable / disable this.

bmuenzenmeyer · 2019-11-23T17:13:44Z

will give this a go later this weekend @sghoweri - thanks!

bmuenzenmeyer

This is working 💃

Ideally, this new config item is added to all edition patternlab-config.json files too.

When features like this are released, we should really document them. I don't think there is any patternlab.io documentation on the theme config. I will add a story if there isn't one. @bradfrost mentioned content being a good next step.

bmuenzenmeyer · 2019-11-24T03:43:11Z

packages/edition-twig/.patternlabrc.js

-  publicPath: '/public/styleguide/',
+  // target the UIKit installed / symlinked under node_modules
+  buildDir: __dirname + '/node_modules/@pattern-lab/uikit-workshop/dist',
+  // noViewAll: true,


I think this can be removed

bmuenzenmeyer · 2019-11-24T12:45:37Z

I don't think there is any patternlab.io documentation on the theme config.

I was wrong - we did add it here https://patternlab.io/docs/advanced-config-options.html but it could certainly be improved with our rewrite / refresh

…links Feature: Add The Ability To Hide Viewall Links

sghoweri added 4 commits July 31, 2019 20:54

feat: add the ability to disable Pattern Lab viewall links in the nav…

156e609

…igation

chore: fresh uikit build

5a806ea

chore: add new commented out config option to the Twig Edition package

de9fe2c

chore: remove config duplicate

6ac1560

sghoweri changed the base branch from feature/uikit-refactor--batched-updates to dev August 20, 2019 06:19

bmuenzenmeyer reviewed Aug 23, 2019

View reviewed changes

Merge remote-tracking branch 'origin' into feature/no-viewall-links

1462104

sghoweri requested a review from raphaelokon as a code owner October 11, 2019 17:48

sghoweri added 3 commits October 11, 2019 13:51

Merge branch 'dev' of https://github.com/pattern-lab/patternlab-node …

677ae59

…into feature/no-viewall-links

chore: fresh uikit build

02d8fc0

fix: comment out example config to disable viewAll links

ddb3fad

feat: test adding cross-env to Twig Edition test

3f8bb01

bmuenzenmeyer added the uikit label Oct 22, 2019

bmuenzenmeyer mentioned this pull request Nov 17, 2019

Simplify UIKit Development Experience / Workflow #1098

Merged

sghoweri added 5 commits November 23, 2019 09:36

Merge branch 'dev' into feature/no-viewall-links

a259165

refactor: update the UIKIt build to recompile PL when the config changes

c3354e7

refactor: update Twig Edition + Handlebars dev edition configs to use…

71f4654

… the updated (optional) noViewAll config

refactor: simplify Nav logic + try to patch up some nav / route relat…

b918cda

…ed issues with pattern keys not always matching up with the3 generated navigation / query string

chore: remove JS from dist folder + update yarn.lock

f4f481c

fix: re-add popstate listener

6dbbd6a

bmuenzenmeyer self-requested a review November 24, 2019 03:42

bmuenzenmeyer approved these changes Nov 24, 2019

View reviewed changes

sghoweri mentioned this pull request Nov 24, 2019

UIKit Nav Cleanup #1102

Merged

bmuenzenmeyer merged commit 2dc87bd into pattern-lab:dev Nov 26, 2019

antonia-rose pushed a commit to quelltexterin/nemo-uikit-workshop that referenced this pull request Apr 12, 2023

Merge pull request pattern-lab#1034 from sghoweri/feature/no-viewall-…

c6bc57c

…links Feature: Add The Ability To Hide Viewall Links

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Add The Ability To Hide Viewall Links #1034

Feature: Add The Ability To Hide Viewall Links #1034

sghoweri commented Aug 1, 2019

jryanconklin commented Aug 16, 2019

bmuenzenmeyer commented Aug 20, 2019

sghoweri commented Aug 20, 2019

bmuenzenmeyer left a comment •

edited

Loading

bmuenzenmeyer Aug 23, 2019

sghoweri Aug 23, 2019

bmuenzenmeyer Oct 11, 2019

sghoweri commented Aug 23, 2019

bmuenzenmeyer commented Oct 11, 2019

sghoweri commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

sghoweri commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

sghoweri commented Oct 11, 2019

bmuenzenmeyer commented Oct 22, 2019 •

edited

Loading

bmuenzenmeyer commented Nov 22, 2019

bmuenzenmeyer commented Nov 23, 2019

bmuenzenmeyer commented Nov 23, 2019

sghoweri commented Nov 23, 2019

bmuenzenmeyer commented Nov 23, 2019

sghoweri commented Nov 23, 2019

bmuenzenmeyer commented Nov 23, 2019

bmuenzenmeyer left a comment •

edited

Loading

bmuenzenmeyer Nov 24, 2019

bmuenzenmeyer commented Nov 24, 2019

Feature: Add The Ability To Hide Viewall Links #1034

Feature: Add The Ability To Hide Viewall Links #1034

Conversation

sghoweri commented Aug 1, 2019

Summary

Details

Before vs After

How To Test

jryanconklin commented Aug 16, 2019

bmuenzenmeyer commented Aug 20, 2019

sghoweri commented Aug 20, 2019

bmuenzenmeyer left a comment • edited Loading

Choose a reason for hiding this comment

bmuenzenmeyer Aug 23, 2019

Choose a reason for hiding this comment

sghoweri Aug 23, 2019

Choose a reason for hiding this comment

bmuenzenmeyer Oct 11, 2019

Choose a reason for hiding this comment

sghoweri commented Aug 23, 2019

bmuenzenmeyer commented Oct 11, 2019

sghoweri commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

sghoweri commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

bmuenzenmeyer commented Oct 11, 2019

sghoweri commented Oct 11, 2019

bmuenzenmeyer commented Oct 22, 2019 • edited Loading

bmuenzenmeyer commented Nov 22, 2019

bmuenzenmeyer commented Nov 23, 2019

bmuenzenmeyer commented Nov 23, 2019

sghoweri commented Nov 23, 2019

bmuenzenmeyer commented Nov 23, 2019

sghoweri commented Nov 23, 2019

bmuenzenmeyer commented Nov 23, 2019

bmuenzenmeyer left a comment • edited Loading

Choose a reason for hiding this comment

bmuenzenmeyer Nov 24, 2019

Choose a reason for hiding this comment

bmuenzenmeyer commented Nov 24, 2019

bmuenzenmeyer left a comment •

edited

Loading

bmuenzenmeyer commented Oct 22, 2019 •

edited

Loading

bmuenzenmeyer left a comment •

edited

Loading