From 8430db4fd8738f80cdb31ff1fd084170ebc51af8 Mon Sep 17 00:00:00 2001 From: Mark Perkins Date: Wed, 22 Nov 2023 14:55:03 +0000 Subject: [PATCH] Add config options to enable/disable preview and page search boxes --- app/views/layouts/lookbook/application.html.erb | 6 +++++- config/app.yml | 2 ++ docs/package-lock.json | 4 ++-- docs/src/_data/config_options.yml | 14 +++++++++++++- 4 files changed, 22 insertions(+), 4 deletions(-) diff --git a/app/views/layouts/lookbook/application.html.erb b/app/views/layouts/lookbook/application.html.erb index 3b226d7bb..d02a3ca70 100644 --- a/app/views/layouts/lookbook/application.html.erb +++ b/app/views/layouts/lookbook/application.html.erb @@ -56,7 +56,9 @@ <% end %> <% end %> <% end %> - <% nav.with_filter store: "$store.nav.previews.filter", placeholder: "Filter previews by name…" %> + <% if @config.preview_search %> + <% nav.with_filter store: "$store.nav.previews.filter", placeholder: "Filter previews by name…" %> + <% end %> <% end %> <% end %> <% end %> @@ -79,7 +81,9 @@ <% end %> <% end %> <% end %> + <% if @config.page_search %> <% nav.with_filter store: "$store.nav.pages.filter", placeholder: "Filter pages by name…" %> + <% end %> <% end %> <% end %> <% end %> diff --git a/config/app.yml b/config/app.yml index 84ee03942..15594e683 100644 --- a/config/app.yml +++ b/config/app.yml @@ -3,6 +3,7 @@ shared: project_logo: ~ preview_collection_label: "Previews" + preview_search: true preview_paths: [test/components/previews] preview_display_options: {} preview_controller: "Lookbook::PreviewController" @@ -24,6 +25,7 @@ shared: preview_sort_scenarios: false page_collection_label: "Pages" + page_search: false page_controller: "Lookbook::PageController" page_route: pages page_paths: [test/components/docs] diff --git a/docs/package-lock.json b/docs/package-lock.json index 65b20ddc2..eee9de866 100644 --- a/docs/package-lock.json +++ b/docs/package-lock.json @@ -1,12 +1,12 @@ { "name": "lookbook-docs", - "version": "2.0.5", + "version": "2.1.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "lookbook-docs", - "version": "2.0.5", + "version": "2.1.1", "dependencies": { "@hotwired/turbo": "^7.2.4", "@tailwindcss/typography": "^0.5.2", diff --git a/docs/src/_data/config_options.yml b/docs/src/_data/config_options.yml index c85349afe..556c7ec7b 100644 --- a/docs/src/_data/config_options.yml +++ b/docs/src/_data/config_options.yml @@ -22,6 +22,12 @@ previews: example: config.lookbook.preview_collection_label = "Component Previews" description: The label used to denote the previews section of the sidebar nav. + - name: preview_search + types: Boolean + default: true + example: config.lookbook.preview_search = false + description: Whether or not to show a search/filter box for previews + - name: preview_paths types: Array default: "[]" @@ -52,7 +58,7 @@ previews: - name: preview_inspector.sidebar_panels types: Array - default: '[:previews, :pages]' + default: "[:previews, :pages]" example: config.lookbook.preview_inspector.sidebar_panels = [:pages, :previews] description: Controls the order and availability of the sidebar navigation panels. @@ -105,6 +111,12 @@ pages: example: config.lookbook.page_collection_label = "Docs" description: The label used to denote the pages section of the sidebar nav. + - name: page_search + types: Boolean + default: false + example: config.lookbook.page_search = false + description: Whether or not to show a search/filter box for pages + - name: page_paths default: "[]" types: Array