commit e1913dc2fa7bf3f775f5bffa202ebe08796db4d7
Author: Sean Carroll
Date: Wed Mar 30 20:26:07 2022 +0200
Deploy website - based on 7cd89fee193c018db24ec1de58eb48a6c76969af
diff --git a/.nojekyll b/.nojekyll
new file mode 100644
index 0000000..e69de29
diff --git a/404.html b/404.html
new file mode 100644
index 0000000..5f52727
--- /dev/null
+++ b/404.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Page Not Found | Ransack documentation
+
+
+
+
+
+
Page Not Found We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
+
+
+
+
\ No newline at end of file
diff --git a/assets/css/styles.03efa0bd.css b/assets/css/styles.03efa0bd.css
new file mode 100644
index 0000000..4d40d4c
--- /dev/null
+++ b/assets/css/styles.03efa0bd.css
@@ -0,0 +1 @@
+.container,.row .col{padding:0 var(--ifm-spacing-horizontal);width:100%}.row .col,img{max-width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown li,body{word-wrap:break-word}body,ol ol,ol ul,ul ol,ul ul{margin:0}pre,table{overflow:auto}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.avatar__photo,.card,.text--truncate{overflow:hidden}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar__title,.text--truncate{text-overflow:ellipsis;white-space:nowrap}.button,.dropdown__link,.navbar__title,.text--truncate{white-space:nowrap}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}.admonition-icon svg,.alert__icon svg{fill:var(--ifm-alert-foreground-color)}.toggleButton_rCf9,html{-webkit-tap-highlight-color:transparent}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:transparent;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:rgba(0,0,0,.05);--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 rgba(0,0,0,.1);--ifm-global-shadow-md:0 5px 40px rgba(0,0,0,.2);--ifm-global-shadow-tl:0 12px 28px 0 rgba(0,0,0,.2),0 2px 4px 0 rgba(0,0,0,.1);--ifm-z-index-dropdown:2;--ifm-z-index-fixed:3;--ifm-z-index-overlay:4;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-color-emphasis-100);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:transparent;--ifm-table-stripe-background:rgba(0,0,0,.03);--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-border-color:var(--ifm-color-emphasis-500);--ifm-hr-border-width:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size-sm:2rem;--ifm-avatar-photo-size-md:3rem;--ifm-avatar-photo-size-lg:4rem;--ifm-avatar-photo-size-xl:6rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.0625rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:1rem;--ifm-breadcrumb-padding-vertical:0.5rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8, ');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-margin:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:1rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8, ');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8, ');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:calc(var(--ifm-global-radius)*var(--ifm-pagination-size-multiplier));--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.0625rem;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-size-multiplier:1;--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.0625rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem;--ifm-tabs-spacing:0.0625rem;--ifm-color-primary:#2e8555;--ifm-color-primary-dark:#29784c;--ifm-color-primary-darker:#277148;--ifm-color-primary-darkest:#205d3b;--ifm-color-primary-light:#33925d;--ifm-color-primary-lighter:#359962;--ifm-color-primary-lightest:#3cad6e;--ifm-code-font-size:95%;--docusaurus-announcement-bar-height:auto;--collapse-button-bg-color-dark:#2e333a;--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300)}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:transparent}*{box-sizing:border-box}html{-webkit-font-smoothing:antialiased;text-rendering:optimizelegibility;-webkit-text-size-adjust:100%;text-size-adjust:100%;background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base)}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.container--fluid{max-width:inherit}.row{display:flex;flex-direction:row;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none{margin-top:0!important}.row .col{--ifm-col-width:100%;flex:1 0;margin-left:0}.row .col[class*=col--]{flex:0 0 var(--ifm-col-width);max-width:var(--ifm-col-width)}.row .col.col--1{--ifm-col-width:8.33333%}.row .col.col--offset-1{margin-left:8.33333%}.row .col.col--2{--ifm-col-width:16.66667%}.row .col.col--offset-2{margin-left:16.66667%}.row .col.col--3{--ifm-col-width:25%}.row .col.col--offset-3{margin-left:25%}.row .col.col--4{--ifm-col-width:33.33333%}.row .col.col--offset-4{margin-left:33.33333%}.row .col.col--5{--ifm-col-width:41.66667%}.row .col.col--offset-5{margin-left:41.66667%}.row .col.col--6{--ifm-col-width:50%}.row .col.col--offset-6{margin-left:50%}.row .col.col--7{--ifm-col-width:58.33333%}.row .col.col--offset-7{margin-left:58.33333%}.row .col.col--8{--ifm-col-width:66.66667%}.row .col.col--offset-8{margin-left:66.66667%}.row .col.col--9{--ifm-col-width:75%}.row .col.col--offset-9{margin-left:75%}.row .col.col--10{--ifm-col-width:83.33333%}.row .col.col--offset-10{margin-left:83.33333%}.row .col.col--11{--ifm-col-width:91.66667%}.row .col.col--offset-11{margin-left:91.66667%}.row .col.col--12{--ifm-col-width:100%}.row .col.col--offset-12{margin-left:100%}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.menuExternalLink_tcZa,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid rgba(0,0,0,.1);border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:transparent;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}blockquote,hr{border-style:solid}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.breadcrumbs__link:hover,.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-color:var(--ifm-blockquote-border-color);border-width:0;border-left-width:var(--ifm-blockquote-border-left-width);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{border-color:var(--ifm-hr-border-color);border-width:var(--ifm-hr-border-width);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonition h5,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:rgba(53,120,229,.15);--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:rgba(235,237,240,.15);--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:rgba(0,164,0,.15);--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:rgba(84,199,236,.15);--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:rgba(255,186,0,.15);--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:rgba(250,56,62,.15);--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border-color:var(--ifm-alert-border-color);border-style:solid;border-width:var(--ifm-alert-border-width);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{-webkit-text-decoration-color:var(--ifm-alert-border-color);text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar,.navbar,.navbar>.container,.navbar>.container-fluid{display:flex}.avatar__photo-link,.tocCollapsibleContent_MpvI a{display:block}.avatar__photo{border-radius:50%;height:var(--ifm-avatar-photo-size-md);width:var(--ifm-avatar-photo-size-md)}.avatar__photo--sm{height:var(--ifm-avatar-photo-size-sm);width:var(--ifm-avatar-photo-size-sm)}.avatar__photo--lg{height:var(--ifm-avatar-photo-size-lg);width:var(--ifm-avatar-photo-size-lg)}.avatar__photo--xl{height:var(--ifm-avatar-photo-size-xl);width:var(--ifm-avatar-photo-size-xl)}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo+.avatar__intro{margin-left:var(--ifm-avatar-intro-margin)}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.avatar--vertical .avatar__intro{margin-left:0}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:first-child){margin-left:var(--ifm-breadcrumb-spacing)}.breadcrumbs__item:not(:last-child){margin-right:var(--ifm-breadcrumb-spacing)}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 .5rem;opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__item--active .breadcrumbs__link,.breadcrumbs__item:not(.breadcrumbs__item--active):hover .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);color:var(--ifm-font-color-base);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border-color:var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);border-style:solid;border-width:var(--ifm-button-border-width);cursor:pointer;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);transition-property:color,background,border-color;-webkit-user-select:none;-ms-user-select:none;user-select:none}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:transparent;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}.button.button--secondary.button--outline:not(.button--active):not(:hover),.sidebarItemLink_miNk{color:var(--ifm-font-color-base)}.button--primary{--ifm-button-border-color:var(--ifm-color-primary)}.button--primary:not(.button--outline){--ifm-button-background-color:var(--ifm-color-primary)}.button--primary:not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-border-color:var(--ifm-color-primary-darker);--ifm-button-background-color:var(--ifm-color-primary-darker);background-color:var(--ifm-color-primary-darker);border-color:var(--ifm-color-primary-darker)}.button--secondary{--ifm-button-border-color:var(--ifm-color-secondary)}.button--secondary:not(.button--outline){--ifm-button-background-color:var(--ifm-color-secondary)}.button--secondary:not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-border-color:var(--ifm-color-secondary-darker);--ifm-button-background-color:var(--ifm-color-secondary-darker);background-color:var(--ifm-color-secondary-darker);border-color:var(--ifm-color-secondary-darker)}.button--success{--ifm-button-border-color:var(--ifm-color-success)}.button--success:not(.button--outline){--ifm-button-background-color:var(--ifm-color-success)}.button--success:not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-border-color:var(--ifm-color-success-darker);--ifm-button-background-color:var(--ifm-color-success-darker);background-color:var(--ifm-color-success-darker);border-color:var(--ifm-color-success-darker)}.button--info{--ifm-button-border-color:var(--ifm-color-info)}.button--info:not(.button--outline){--ifm-button-background-color:var(--ifm-color-info)}.button--info:not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-border-color:var(--ifm-color-info-darker);--ifm-button-background-color:var(--ifm-color-info-darker);background-color:var(--ifm-color-info-darker);border-color:var(--ifm-color-info-darker)}.button--warning{--ifm-button-border-color:var(--ifm-color-warning)}.button--warning:not(.button--outline){--ifm-button-background-color:var(--ifm-color-warning)}.button--warning:not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-border-color:var(--ifm-color-warning-darker);--ifm-button-background-color:var(--ifm-color-warning-darker);background-color:var(--ifm-color-warning-darker);border-color:var(--ifm-color-warning-darker)}.button--danger{--ifm-button-border-color:var(--ifm-color-danger)}.button--danger:not(.button--outline){--ifm-button-background-color:var(--ifm-color-danger)}.button--danger:not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-border-color:var(--ifm-color-danger-darker);--ifm-button-background-color:var(--ifm-color-danger-darker);background-color:var(--ifm-color-danger-darker);border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0;margin-left:var(--ifm-button-group-margin)}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group>.button--active{z-index:1}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.admonition-content>:last-child,.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;transform:translateY(0);visibility:visible}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;list-style:none;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor transparent;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:10rem}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.footer__item{margin-top:0}.footer__items{list-style:none;margin-bottom:0;padding-left:0}.codeBlockStandalone_csWH,[type=checkbox]{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.blogPostTitle_rzP5,.hero__title{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{list-style:none;margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{display:flex}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none}.menu__caret:before,.menu__link--sublist-caret:after{height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast) linear;width:1.25rem;content:"";filter:var(--ifm-menu-link-sublist-icon-filter)}.menu__link--sublist-caret{justify-content:space-between}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;min-width:1.25rem}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret{margin-left:.1rem}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar--fixed-top{position:-webkit-sticky;position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;position:fixed;transition-timing-function:ease-in-out;top:0;left:0;visibility:hidden}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar__title{flex:1 1 auto;overflow:hidden}.sidebar_a9qW,.tableOfContents_cNA8{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.navbar__items--center .navbar__brand{margin:0}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__items--right>:last-child{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}#nprogress,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:hsla(0,0%,100%,.1);--ifm-navbar-search-input-placeholder-color:hsla(0,0%,100%,.5);color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:hsla(0,0%,100%,.05);--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{-webkit-appearance:none;appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:.9rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input:-ms-input-placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);transform:translate3d(-100%,0,0);transition-duration:.25s;transition-property:opacity,visibility,transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar__items{transform:translateZ(0)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar__backdrop{background-color:rgba(0,0,0,.6);right:0;transition-duration:.1s;transition-property:opacity,visibility}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));transition:transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination__item,.pagination__link{display:inline-block}.pagination{font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.pagination__item:not(:first-child){margin-left:var(--ifm-pagination-page-spacing)}.pagination__item:not(:last-child){margin-right:var(--ifm-pagination-page-spacing)}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover,.sidebarItemLink_miNk:hover{text-decoration:none}.pagination-nav{display:flex}.pagination-nav__item{display:flex;flex:1 50%;max-width:50%}.pagination-nav__item--next{text-align:right}.pagination-nav__item+.pagination-nav__item{margin-left:var(--ifm-spacing-horizontal)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);flex-grow:1;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__item:first-child .pagination-nav__label:before{content:"« "}.pagination-nav__item--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills,.sidebarItemTitle_uKok,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pills__item--active{background:var(--ifm-pills-color-background-active);color:var(--ifm-pills-color-active)}.pills__item:not(.pills__item--active):hover{background-color:var(--ifm-pills-color-background-active)}.pills__item:not(:first-child){margin-left:var(--ifm-pills-spacing)}.pills__item:not(:last-child){margin-right:var(--ifm-pills-spacing)}.docItemContainer_vinB article>:first-child,.docItemContainer_vinB header+*,.pills__item+.pills__item{margin-top:0}.pills--block{display:flex;justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto;padding-left:0}.tabs__item{border-bottom:3px solid transparent;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#18191a;--ifm-background-surface-color:#242526;--ifm-hover-overlay:hsla(0,0%,100%,.05);--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:#333437;--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:hsla(0,0%,100%,.07);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec}.admonition h5{margin-bottom:8px;margin-top:0}.admonition-icon{display:inline-block;margin-right:.4em;vertical-align:middle}.admonition-icon svg{stroke-width:0;stroke:var(--ifm-alert-foreground-color);display:inline-block;height:22px;width:22px}.admonition{margin-bottom:1em}[data-theme=dark]{--ifm-color-primary:#25c2a0;--ifm-color-primary-dark:#21af90;--ifm-color-primary-darker:#1fa588;--ifm-color-primary-darkest:#1a8870;--ifm-color-primary-light:#29d5b0;--ifm-color-primary-lighter:#32d8b4;--ifm-color-primary-lightest:#4fddbf}.docusaurus-highlight-code-line{background-color:rgba(0,0,0,.1);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}[data-theme=dark] .docusaurus-highlight-code-line{background-color:rgba(0,0,0,.3)}#nprogress .bar{background:#29d;height:2px;left:0;position:fixed;top:0;width:100%;z-index:5}#nprogress .peg{box-shadow:0 0 10px #29d,0 0 5px #29d;height:100%;opacity:1;position:absolute;right:0;transform:rotate(3deg) translateY(-4px);width:100px}#docusaurus-base-url-issue-banner-container{display:none}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;list-style:none;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:transparent transparent transparent var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;transform:rotate(0);transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}body:not(.navigation-with-keyboard) :not(input):focus{outline:0}.skipToContent_ZgBM{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_ZgBM:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.announcementBar_IbjG{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.collapseSidebarButton_FykI,.docSidebarContainer_rKC_,.sidebarLogo_YUvz,.themedImage_W2Cr,[data-theme=dark] .lightToggleIcon_v35p,[data-theme=light] .darkToggleIcon_nQuB,html[data-announcement-bar-initially-dismissed=true] .announcementBar_IbjG{display:none}.announcementBarPlaceholder_NC_W{flex:0 0 10px}.announcementBarClose_FG1z{align-self:stretch;flex:0 0 30px;line-height:0;padding:0}.announcementBarContent_KsVm{flex:1 1 auto;font-size:85%;padding:5px 0;text-align:center}.announcementBarContent_KsVm a{color:inherit;text-decoration:underline}.toggle_S7eR{height:2rem;width:2rem}.toggleButton_rCf9{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_rCf9:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_Pu9x{cursor:not-allowed}[data-theme=dark] .themedImage--dark_oUvU,[data-theme=light] .themedImage--light_TfLj{display:initial}.iconExternalLink_I5OW{margin-left:.3rem}.iconLanguage_dNtB{margin-right:5px;vertical-align:text-bottom}.navbarHideable_ObN2{transition:transform var(--ifm-transition-fast) ease}.navbarHidden_FtgE{transform:translate3d(0,calc(-100% - 2px),0)}.footerLogoLink_gHmE{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_gHmE:hover,.hash-link:focus,:hover>.hash-link{opacity:1}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.main-wrapper{flex:1 0 auto}.docusaurus-mt-lg{margin-top:3rem}.sidebar_a9qW{position:-webkit-sticky;position:sticky;top:calc(var(--ifm-navbar-height) + 2rem)}.sidebarItemTitle_uKok{font-size:var(--ifm-h3-font-size)}.sidebarItemList_Kvuv{font-size:.9rem;list-style:none;padding-left:0}.sidebarItem_CF0Q{margin-top:.7rem}.sidebarItemLinkActive_RRTD{color:var(--ifm-color-primary)!important}.backToTopButton_RiI4{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_RiI4:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_ssHd{opacity:1;transform:scale(1);visibility:visible}.docMainContainer_TCnq,.docPage_P2Lg{display:flex;width:100%}.iconEdit_dcUD{margin-right:.3em;vertical-align:sub}.tag_hD8n{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_hD8n:hover{--docusaurus-tag-list-border:var(--ifm-link-color);text-decoration:none}.tagRegular_D6E_{border-radius:.5rem;font-size:90%;padding:.3rem .5rem}.tagWithCount_i0QQ{align-items:center;border-left:0;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_i0QQ:after,.tagWithCount_i0QQ:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_i0QQ:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_i0QQ:after{border-radius:50%;height:.5rem;left:0;transform:translateY(-50%);width:.5rem}.tagWithCount_i0QQ span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tag_Shcx{display:inline-block;margin:.5rem .5rem 0 1rem}.tags_XVD_{display:inline}.tag_JSN8{display:inline-block;margin:0 .4rem .5rem 0}.lastUpdated_foO9{font-size:smaller;font-style:italic;margin-top:.2rem}.copyButton_eDfN{background:inherit;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;opacity:0;padding:.4rem;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2);transition:opacity .2s ease-in-out}.copyButton_eDfN:focus-visible,.copyButton_eDfN:hover,.theme-code-block:hover .copyButtonCopied_ljy5{opacity:1!important}.theme-code-block:hover .copyButton_eDfN:not(.copyButtonCopied_ljy5){opacity:.4}.copyButtonIcons_W9eQ{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_XEyF,.copyButtonSuccessIcon_i9w9{fill:currentColor;height:inherit;left:0;opacity:inherit;position:absolute;top:0;transition:.15s;width:inherit}.copyButtonSuccessIcon_i9w9{color:#00d600;left:50%;opacity:0;top:50%;transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_ljy5 .copyButtonIcon_XEyF{opacity:0;transform:scale(.33)}.copyButtonCopied_ljy5 .copyButtonSuccessIcon_i9w9{opacity:1;transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.codeBlockContainer_I0IT{box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlockContent_wNvx{border-radius:var(--ifm-global-radius);direction:ltr;position:relative}.codeBlockTitle_BvAR{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:var(--ifm-global-radius);border-top-right-radius:var(--ifm-global-radius);font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_jd64{background-color:inherit;margin:0;padding:0}.codeBlockTitle_BvAR+.codeBlockContent_wNvx .codeBlock_jd64{border-top-left-radius:0;border-top-right-radius:0}.codeBlockLines_mRuA{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.details_BAp3{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}.anchorWithStickyNavbar_mojV{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_R0VQ{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;-ms-user-select:none;user-select:none}.hash-link:before{content:"#"}.contains-task-list_tsSF{list-style:none;padding-left:0}.tableOfContents_cNA8{position:-webkit-sticky;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.tocCollapsible_jdIR{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleButton_Fzxq{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_Fzxq:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleContent_MpvI>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_MpvI ul li{margin:.4rem .8rem}.tocCollapsibleExpanded_laf4 .tocCollapsibleButton_Fzxq:after{transform:none}.breadcrumbsContainer_Xlws{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}.img_E7b_{height:auto}.mdxPageWrapper_zHyg{justify-content:center}.blogPostData_Zg1s{font-size:.9rem}.blogPostDetailsFull_h6_j{flex-direction:column}.image_o0gy{height:100%;object-fit:cover;width:100%}.authorCol_FlmR{flex-grow:1!important;max-width:inherit!important}.imageOnlyAuthorRow_trpF{display:flex;flex-flow:row wrap}.imageOnlyAuthorCol_S2np{margin-left:.3rem;margin-right:.3rem}@media (min-width:997px){:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_FG1z,.announcementBarPlaceholder_NC_W{flex-basis:50px}.collapseSidebarButton_FykI{background-color:var(--ifm-button-background-color);border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:-webkit-sticky;position:sticky}.collapseSidebarButtonIcon_DTRl{margin-top:4px;transform:rotate(180deg)}.expandSidebarButtonIcon_AV8S,[dir=rtl] .collapseSidebarButtonIcon_DTRl{transform:rotate(0)}[data-theme=dark] .collapseSidebarButton_FykI,[data-theme=dark] .collapsedDocSidebar_Xgr6:focus,[data-theme=dark] .collapsedDocSidebar_Xgr6:hover{background-color:var(--collapse-button-bg-color-dark)}.collapsedDocSidebar_Xgr6:focus,.collapsedDocSidebar_Xgr6:hover,[data-theme=dark] .collapseSidebarButton_FykI:focus,[data-theme=dark] .collapseSidebarButton_FykI:hover{background-color:var(--ifm-color-emphasis-200)}.menuHtmlItem_fVIQ{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_izAj{flex-grow:1;padding:.5rem}.menuWithAnnouncementBar_l2a_{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_RiAD{display:flex;flex-direction:column;height:100%;max-height:100vh;padding-top:var(--ifm-navbar-height);position:-webkit-sticky;position:sticky;top:0;transition:opacity 50ms;width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_d0QC{padding-top:0}.sidebarHidden_Lg_2{height:0;opacity:0;overflow:hidden;visibility:hidden}.sidebarLogo_YUvz{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_YUvz img{height:2rem;margin-right:.5rem}.docMainContainer_TCnq{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_WDCb{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docSidebarContainer_rKC_{border-right:1px solid var(--ifm-toc-border-color);-webkit-clip-path:inset(0);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_nvlY{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.collapsedDocSidebar_Xgr6{align-items:center;display:flex;height:100%;justify-content:center;max-height:100vh;position:-webkit-sticky;position:sticky;top:0;transition:background-color var(--ifm-transition-fast) ease}[dir=rtl] .expandSidebarButtonIcon_AV8S{transform:rotate(180deg)}.docItemWrapperEnhanced_r_WG{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.lastUpdated_foO9{text-align:right}.docItemCol_DM6M{max-width:75%!important}.tocMobile_TmEX{display:none}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.row .col.col.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_vKtC,.footer__link-separator,.navbar__item,.sidebar_a9qW,.tableOfContents_cNA8{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.pills--block .pills__item:not(:first-child){margin-top:var(--ifm-pills-spacing)}.pills--block .pills__item:not(:last-child){margin-bottom:var(--ifm-pills-spacing)}.tabs--block .tabs__item:not(:first-child){margin-top:var(--ifm-tabs-spacing)}.tabs--block .tabs__item:not(:last-child){margin-bottom:var(--ifm-tabs-spacing)}.docItemContainer_WX_Y{padding:0 .3rem}}@media (hover:hover){.backToTopButton_RiI4:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media print{.announcementBar_IbjG,.footer,.menu,.navbar,.pagination-nav,.table-of-contents{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_mRuA{white-space:pre-wrap}}
\ No newline at end of file
diff --git a/assets/images/create_release-75ee0e14ec6cf852308310ea9a867558.png b/assets/images/create_release-75ee0e14ec6cf852308310ea9a867558.png
new file mode 100644
index 0000000..d093b26
Binary files /dev/null and b/assets/images/create_release-75ee0e14ec6cf852308310ea9a867558.png differ
diff --git a/assets/js/009f1e98.31b62105.js b/assets/js/009f1e98.31b62105.js
new file mode 100644
index 0000000..a6a6f8a
--- /dev/null
+++ b/assets/js/009f1e98.31b62105.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([[436],{3905:function(e,n,t){t.d(n,{Zo:function(){return u},kt:function(){return f}});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),l=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},u=function(e){var n=l(e.components);return r.createElement(s.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),d=l(t),f=a,m=d["".concat(s,".").concat(f)]||d[f]||p[f]||i;return t?r.createElement(m,o(o({ref:n},u),{},{components:t})):r.createElement(m,o({ref:n},u))}));function f(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=d;var c={};for(var s in n)hasOwnProperty.call(n,s)&&(c[s]=n[s]);c.originalType=e,c.mdxType="string"==typeof e?e:a,o[1]=c;for(var l=2;l\n<%= sort_link(@search) %>\n")))}f.isMDXComponent=!0}}]);
\ No newline at end of file
diff --git a/assets/js/01a85c17.9208edce.js b/assets/js/01a85c17.9208edce.js
new file mode 100644
index 0000000..ab195e1
--- /dev/null
+++ b/assets/js/01a85c17.9208edce.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([[13],{8665:function(e,t,a){a.d(t,{Z:function(){return f}});var n=a(3366),r=a(7294),l=a(6010),c=a(2600),i=a(9960),s="sidebar_a9qW",m="sidebarItemTitle_uKok",o="sidebarItemList_Kvuv",u="sidebarItem_CF0Q",d="sidebarItemLink_miNk",g="sidebarItemLinkActive_RRTD",E=a(5999);function b(e){var t=e.sidebar;return 0===t.items.length?null:r.createElement("nav",{className:(0,l.Z)(s,"thin-scrollbar"),"aria-label":(0,E.I)({id:"theme.blog.sidebar.navAriaLabel",message:"Blog recent posts navigation",description:"The ARIA label for recent posts in the blog sidebar"})},r.createElement("div",{className:(0,l.Z)(m,"margin-bottom--md")},t.title),r.createElement("ul",{className:o},t.items.map((function(e){return r.createElement("li",{key:e.permalink,className:u},r.createElement(i.Z,{isNavLink:!0,to:e.permalink,className:d,activeClassName:g},e.title))}))))}var v=["sidebar","toc","children"];function f(e){var t=e.sidebar,a=e.toc,i=e.children,s=(0,n.Z)(e,v),m=t&&t.items.length>0;return r.createElement(c.Z,s,r.createElement("div",{className:"container margin-vert--lg"},r.createElement("div",{className:"row"},m&&r.createElement("aside",{className:"col col--3"},r.createElement(b,{sidebar:t})),r.createElement("main",{className:(0,l.Z)("col",{"col--7":m,"col--9 col--offset-1":!m}),itemScope:!0,itemType:"http://schema.org/Blog"},i),a&&r.createElement("div",{className:"col col--2"},a))))}},497:function(e,t,a){a.r(t),a.d(t,{default:function(){return d}});var n=a(7294),r=a(8665),l=a(7774),c=a(5979),i="tag_Shcx";function s(e){var t=e.letterEntry;return n.createElement("article",null,n.createElement("h2",null,t.letter),n.createElement("ul",{className:"padding--none"},t.tags.map((function(e){return n.createElement("li",{key:e.permalink,className:i},n.createElement(l.Z,e))}))),n.createElement("hr",null))}function m(e){var t=e.tags,a=(0,c.PZ)(t);return n.createElement("section",{className:"margin-vert--lg"},a.map((function(e){return n.createElement(s,{key:e.letter,letterEntry:e})})))}var o=a(4739),u=a(6010);function d(e){var t=e.tags,a=e.sidebar,l=(0,c.MA)();return n.createElement(c.FG,{className:(0,u.Z)(c.kM.wrapper.blogPages,c.kM.page.blogTagsListPage)},n.createElement(c.d,{title:l}),n.createElement(o.Z,{tag:"blog_tags_list"}),n.createElement(r.Z,{sidebar:a},n.createElement("h1",null,l),n.createElement(m,{tags:Object.values(t)})))}},7774:function(e,t,a){a.d(t,{Z:function(){return m}});var n=a(7294),r=a(6010),l=a(9960),c="tag_hD8n",i="tagRegular_D6E_",s="tagWithCount_i0QQ";function m(e){var t=e.permalink,a=e.name,m=e.count;return n.createElement(l.Z,{href:t,className:(0,r.Z)(c,m?s:i)},a,m&&n.createElement("span",null,m))}}}]);
\ No newline at end of file
diff --git a/assets/js/01befa62.fcae236d.js b/assets/js/01befa62.fcae236d.js
new file mode 100644
index 0000000..60d984c
--- /dev/null
+++ b/assets/js/01befa62.fcae236d.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([[939],{3905:function(e,r,n){n.d(r,{Zo:function(){return p},kt:function(){return f}});var t=n(7294);function o(e,r,n){return r in e?Object.defineProperty(e,r,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[r]=n,e}function a(e,r){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var t=Object.getOwnPropertySymbols(e);r&&(t=t.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),n.push.apply(n,t)}return n}function i(e){for(var r=1;r=0||(o[n]=e[n]);return o}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(t=0;t=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var c=t.createContext({}),l=function(e){var r=t.useContext(c),n=r;return e&&(n="function"==typeof e?e(r):i(i({},r),e)),n},p=function(e){var r=l(e.components);return t.createElement(c.Provider,{value:r},e.children)},u={inlineCode:"code",wrapper:function(e){var r=e.children;return t.createElement(t.Fragment,{},r)}},d=t.forwardRef((function(e,r){var n=e.components,o=e.mdxType,a=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=l(n),f=o,h=d["".concat(c,".").concat(f)]||d[f]||u[f]||a;return n?t.createElement(h,i(i({ref:r},p),{},{components:n})):t.createElement(h,i({ref:r},p))}));function f(e,r){var n=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=d;var s={};for(var c in r)hasOwnProperty.call(r,c)&&(s[c]=r[c]);s.originalType=e,s.mdxType="string"==typeof e?e:o,i[1]=s;for(var l=2;l=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),c=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},p=function(e){var t=c(e.components);return r.createElement(l.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),k=c(a),m=n,d=k["".concat(l,".").concat(m)]||k[m]||u[m]||o;return a?r.createElement(d,i(i({ref:t},p),{},{components:a})):r.createElement(d,i({ref:t},p))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,i=new Array(o);i[0]=k;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:n,i[1]=s;for(var c=2;c 'activerecord-hackery/ransack', :branch => 'main'\n")),(0,o.kt)("h3",{id:"demo-application"},"Demo application"),(0,o.kt)("p",null,"The ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/activerecord-hackery/ransack_demo"},"Ransack Demo application")," shows how to create ",(0,o.kt)("a",{parentName:"p",href:"http://ransack-demo.herokuapp.com"},"simple")," and\n",(0,o.kt)("a",{parentName:"p",href:"http://ransack-demo.herokuapp.com/users/advanced_search"},"advanced")," search forms for your Ruby on Rails application."),(0,o.kt)("h2",{id:"issues-tracker"},"Issues tracker"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Before filing an issue, please read the ",(0,o.kt)("a",{parentName:"li",href:"https://github.com/activerecord-hackery/ransack/CONTRIBUTING.md"},"Contributing Guide"),"."),(0,o.kt)("li",{parentName:"ul"},"File an issue if a bug is caused by Ransack, is new (has not already been reported), and ",(0,o.kt)("em",{parentName:"li"},"can be reproduced from the information you provide"),"."),(0,o.kt)("li",{parentName:"ul"},"Please consider adding a branch with a failing spec describing the problem."),(0,o.kt)("li",{parentName:"ul"},"Contributions are welcome. \ud83d\ude03"),(0,o.kt)("li",{parentName:"ul"},"Please do not use the issue tracker for personal support requests. Stack Overflow is a better place for that where a wider community can help you!")),(0,o.kt)("h2",{id:"contributions"},"Contributions"),(0,o.kt)("p",null,"To support the project:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Consider supporting us via ",(0,o.kt)("a",{parentName:"li",href:"https://opencollective.com/ransack/backers/badge.svg"},"Open Collective")),(0,o.kt)("li",{parentName:"ul"},"Use Ransack in your apps, and let us know if you encounter anything that's\nbroken or missing. A failing spec to demonstrate the issue is awesome. A pull\nrequest with passing tests is even better!"),(0,o.kt)("li",{parentName:"ul"},"Before filing an issue or pull request, be sure to read and follow the\n",(0,o.kt)("a",{parentName:"li",href:"https://github.com/activerecord-hackery/ransack/CONTRIBUTING.md"},"Contributing Guide"),"."),(0,o.kt)("li",{parentName:"ul"},"Please use Stack Overflow or other sites for questions or discussion not\ndirectly related to bug reports, pull requests, or documentation improvements."),(0,o.kt)("li",{parentName:"ul"},"Spread the word on Twitter, Facebook, and elsewhere if Ransack's been useful\nto you. The more people who are using the project, the quicker we can find and\nfix bugs!")),(0,o.kt)("h2",{id:"contributors"},"Contributors"),(0,o.kt)("p",null,"Ransack was created by ",(0,o.kt)("a",{parentName:"p",href:"http://twitter.com/erniemiller"},"Ernie Miller")," and is developed and maintained by:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://github.com/scarroll32"},"Sean Carroll")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://github.com/deivid-rodriguez"},"Deivid Rodriguez")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://github.com/gregmolnar"},"Greg Molnar")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://github.com/activerecord-hackery/ransack/graphs/contributors"},"A great group of contributors"),".")),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Ransack's logo is designed by ",(0,o.kt)("a",{parentName:"li",href:"https://github.com/anilkilic"},"An\u0131l K\u0131l\u0131\xe7"),".")),(0,o.kt)("p",null,"Alumni Maintainers"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"http://twitter.com/jonatack"},"Jon Atack")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"http://twitter.com/ryanbigg"},"Ryan Bigg"))),(0,o.kt)("p",null,"This project exists thanks to all the people who contribute. ",(0,o.kt)("img",{src:"https://opencollective.com/ransack/contributors.svg?width=890&button=false"})),(0,o.kt)("h2",{id:"backers"},"Backers"),(0,o.kt)("p",null,"Thank you to all our backers! \ud83d\ude4f [",(0,o.kt)("a",{parentName:"p",href:"https://opencollective.com/ransack#backer"},"Become a backer"),"]"),(0,o.kt)("a",{href:"https://opencollective.com/ransack#backers",target:"_blank"},(0,o.kt)("img",{src:"https://opencollective.com/ransack/backers.svg?width=890"})),(0,o.kt)("h2",{id:"sponsors"},"Sponsors"),(0,o.kt)("p",null,"Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [",(0,o.kt)("a",{parentName:"p",href:"https://opencollective.com/ransack#sponsor"},"Become a sponsor"),"]"),(0,o.kt)("a",{href:"https://opencollective.com/ransack/sponsor/0/website",target:"_blank"},(0,o.kt)("img",{src:"https://opencollective.com/ransack/sponsor/0/avatar.svg"})),(0,o.kt)("a",{href:"https://opencollective.com/ransack/sponsor/1/website",target:"_blank"},(0,o.kt)("img",{src:"https://opencollective.com/ransack/sponsor/1/avatar.svg"})),(0,o.kt)("a",{href:"https://opencollective.com/ransack/sponsor/2/website",target:"_blank"},(0,o.kt)("img",{src:"https://opencollective.com/ransack/sponsor/2/avatar.svg"})),(0,o.kt)("a",{href:"https://opencollective.com/ransack/sponsor/3/website",target:"_blank"},(0,o.kt)("img",{src:"https://opencollective.com/ransack/sponsor/3/avatar.svg"})),(0,o.kt)("a",{href:"https://opencollective.com/ransack/sponsor/4/website",target:"_blank"},(0,o.kt)("img",{src:"https://opencollective.com/ransack/sponsor/4/avatar.svg"})),(0,o.kt)("a",{href:"https://opencollective.com/ransack/sponsor/5/website",target:"_blank"},(0,o.kt)("img",{src:"https://opencollective.com/ransack/sponsor/5/avatar.svg"})),(0,o.kt)("a",{href:"https://opencollective.com/ransack/sponsor/6/website",target:"_blank"},(0,o.kt)("img",{src:"https://opencollective.com/ransack/sponsor/6/avatar.svg"})),(0,o.kt)("a",{href:"https://opencollective.com/ransack/sponsor/7/website",target:"_blank"},(0,o.kt)("img",{src:"https://opencollective.com/ransack/sponsor/7/avatar.svg"})),(0,o.kt)("a",{href:"https://opencollective.com/ransack/sponsor/8/website",target:"_blank"},(0,o.kt)("img",{src:"https://opencollective.com/ransack/sponsor/8/avatar.svg"})),(0,o.kt)("a",{href:"https://opencollective.com/ransack/sponsor/9/website",target:"_blank"},(0,o.kt)("img",{src:"https://opencollective.com/ransack/sponsor/9/avatar.svg"})))}m.isMDXComponent=!0}}]);
\ No newline at end of file
diff --git a/assets/js/17896441.5557c43f.js b/assets/js/17896441.5557c43f.js
new file mode 100644
index 0000000..8730131
--- /dev/null
+++ b/assets/js/17896441.5557c43f.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([[918],{2179:function(e,t,a){a.r(t),a.d(t,{default:function(){return j}});var n=a(7294),l=a(6010),r=a(7462),i=a(5999),s=a(1750);function c(e){var t=e.previous,a=e.next;return n.createElement("nav",{className:"pagination-nav docusaurus-mt-lg","aria-label":(0,i.I)({id:"theme.docs.paginator.navAriaLabel",message:"Docs pages navigation",description:"The ARIA label for the docs pagination"})},n.createElement("div",{className:"pagination-nav__item"},t&&n.createElement(s.Z,(0,r.Z)({},t,{subLabel:n.createElement(i.Z,{id:"theme.docs.paginator.previous",description:"The label used to navigate to the previous doc"},"Previous")}))),n.createElement("div",{className:"pagination-nav__item pagination-nav__item--next"},a&&n.createElement(s.Z,(0,r.Z)({},a,{subLabel:n.createElement(i.Z,{id:"theme.docs.paginator.next",description:"The label used to navigate to the next doc"},"Next")}))))}var o=a(2263),m=a(9960),d=a(5551),u=a(5979);var v={unreleased:function(e){var t=e.siteTitle,a=e.versionMetadata;return n.createElement(i.Z,{id:"theme.docs.versions.unreleasedVersionLabel",description:"The label used to tell the user that he's browsing an unreleased doc version",values:{siteTitle:t,versionLabel:n.createElement("b",null,a.label)}},"This is unreleased documentation for {siteTitle} {versionLabel} version.")},unmaintained:function(e){var t=e.siteTitle,a=e.versionMetadata;return n.createElement(i.Z,{id:"theme.docs.versions.unmaintainedVersionLabel",description:"The label used to tell the user that he's browsing an unmaintained doc version",values:{siteTitle:t,versionLabel:n.createElement("b",null,a.label)}},"This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.")}};function b(e){var t=v[e.versionMetadata.banner];return n.createElement(t,e)}function p(e){var t=e.versionLabel,a=e.to,l=e.onClick;return n.createElement(i.Z,{id:"theme.docs.versions.latestVersionSuggestionLabel",description:"The label used to tell the user to check the latest version",values:{versionLabel:t,latestVersionLink:n.createElement("b",null,n.createElement(m.Z,{to:a,onClick:l},n.createElement(i.Z,{id:"theme.docs.versions.latestVersionLinkLabel",description:"The label used for the latest version suggestion link label"},"latest version")))}},"For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).")}function E(e){var t,a=e.className,r=e.versionMetadata,i=(0,o.Z)().siteConfig.title,s=(0,d.gA)({failfast:!0}).pluginId,c=(0,u.J)(s).savePreferredVersionName,m=(0,d.Jo)(s),v=m.latestDocSuggestion,E=m.latestVersionSuggestion,g=null!=v?v:(t=E).docs.find((function(e){return e.id===t.mainDocId}));return n.createElement("div",{className:(0,l.Z)(a,u.kM.docs.docVersionBanner,"alert alert--warning margin-bottom--md"),role:"alert"},n.createElement("div",null,n.createElement(b,{siteTitle:i,versionMetadata:r})),n.createElement("div",{className:"margin-top--md"},n.createElement(p,{versionLabel:E.label,to:g.path,onClick:function(){return c(E.name)}})))}function g(e){var t=e.className,a=(0,u.E6)();return a.banner?n.createElement(E,{className:t,versionMetadata:a}):null}function h(e){var t=e.className,a=(0,u.E6)();return a.badge?n.createElement("span",{className:(0,l.Z)(t,u.kM.docs.docVersionBadge,"badge badge--secondary")},n.createElement(i.Z,{id:"theme.docs.versionBadge.label",values:{versionLabel:a.label}},"Version: {versionLabel}")):null}function f(e){var t=e.lastUpdatedAt,a=e.formattedLastUpdatedAt;return n.createElement(i.Z,{id:"theme.lastUpdated.atDate",description:"The words used to describe on which date a page has been last updated",values:{date:n.createElement("b",null,n.createElement("time",{dateTime:new Date(1e3*t).toISOString()},a))}}," on {date}")}function N(e){var t=e.lastUpdatedBy;return n.createElement(i.Z,{id:"theme.lastUpdated.byUser",description:"The words used to describe by who the page has been last updated",values:{user:n.createElement("b",null,t)}}," by {user}")}function _(e){var t=e.lastUpdatedAt,a=e.formattedLastUpdatedAt,l=e.lastUpdatedBy;return n.createElement("span",{className:u.kM.common.lastUpdated},n.createElement(i.Z,{id:"theme.lastUpdated.lastUpdatedAtBy",description:"The sentence used to display when a page has been last updated, and by who",values:{atDate:t&&a?n.createElement(f,{lastUpdatedAt:t,formattedLastUpdatedAt:a}):"",byUser:l?n.createElement(N,{lastUpdatedBy:l}):""}},"Last updated{atDate}{byUser}"),!1)}var Z=a(6753),k=a(62),L="lastUpdated_foO9";function C(e){return n.createElement("div",{className:(0,l.Z)(u.kM.docs.docFooterTagsRow,"row margin-bottom--sm")},n.createElement("div",{className:"col"},n.createElement(k.Z,e)))}function U(e){var t=e.editUrl,a=e.lastUpdatedAt,r=e.lastUpdatedBy,i=e.formattedLastUpdatedAt;return n.createElement("div",{className:(0,l.Z)(u.kM.docs.docFooterEditMetaRow,"row")},n.createElement("div",{className:"col"},t&&n.createElement(Z.Z,{editUrl:t})),n.createElement("div",{className:(0,l.Z)("col",L)},(a||r)&&n.createElement(_,{lastUpdatedAt:a,formattedLastUpdatedAt:i,lastUpdatedBy:r})))}function T(e){var t=e.content.metadata,a=t.editUrl,r=t.lastUpdatedAt,i=t.formattedLastUpdatedAt,s=t.lastUpdatedBy,c=t.tags,o=c.length>0,m=!!(a||r||s);return o||m?n.createElement("footer",{className:(0,l.Z)(u.kM.docs.docFooter,"docusaurus-mt-lg")},o&&n.createElement(C,{tags:c}),m&&n.createElement(U,{editUrl:a,lastUpdatedAt:r,lastUpdatedBy:s,formattedLastUpdatedAt:i})):null}var y=a(1575),M="tocCollapsible_jdIR",w="tocCollapsibleButton_Fzxq",A="tocCollapsibleContent_MpvI",x="tocCollapsibleExpanded_laf4",H=a(5002);function B(e){var t=e.toc,a=e.className,r=e.minHeadingLevel,s=e.maxHeadingLevel,c=(0,u.uR)({initialState:!0}),o=c.collapsed,m=c.toggleCollapsed;return n.createElement("div",{className:(0,l.Z)(M,!o&&x,a)},n.createElement("button",{type:"button",className:(0,l.Z)("clean-btn",w),onClick:m},n.createElement(i.Z,{id:"theme.TOCCollapsible.toggleButtonLabel",description:"The label used by the button on the collapsible TOC component"},"On this page")),n.createElement(u.zF,{lazy:!0,className:A,collapsed:o},n.createElement(H.Z,{toc:t,minHeadingLevel:r,maxHeadingLevel:s})))}var D=a(9649),I="docItemContainer_vinB",S="docItemCol_DM6M",V="tocMobile_TmEX",P={breadcrumbsContainer:"breadcrumbsContainer_Xlws"},F=a(4996);function O(e){var t=e.children,a=e.href,l="breadcrumbs__link";return a?n.createElement(m.Z,{className:l,href:a,itemProp:"item"},n.createElement("span",{itemProp:"name"},t)):n.createElement("span",{className:l,itemProp:"item name"},t)}function R(e){var t=e.children,a=e.active,r=e.index;return n.createElement("li",{itemScope:!0,itemProp:"itemListElement",itemType:"https://schema.org/ListItem",className:(0,l.Z)("breadcrumbs__item",{"breadcrumbs__item--active":a})},t,n.createElement("meta",{itemProp:"position",content:String(r+1)}))}function z(){var e=(0,F.Z)("/");return n.createElement("li",{className:"breadcrumbs__item"},n.createElement(m.Z,{className:(0,l.Z)("breadcrumbs__link",P.breadcrumbsItemLink),href:e},"\ud83c\udfe0"))}function q(){var e=(0,u.s1)(),t=(0,u.Ns)();return e?n.createElement("nav",{className:(0,l.Z)(u.kM.docs.docBreadcrumbs,P.breadcrumbsContainer),"aria-label":"breadcrumbs"},n.createElement("ul",{className:"breadcrumbs",itemScope:!0,itemType:"https://schema.org/BreadcrumbList"},t&&n.createElement(z,null),e.map((function(t,a){return n.createElement(R,{key:a,active:a===e.length-1,index:a},n.createElement(O,{href:a0,E=p&&("desktop"===b||"ssr"===b);return n.createElement("div",{className:"row"},n.createElement("div",{className:(0,l.Z)("col",!s&&S)},n.createElement(g,null),n.createElement("div",{className:I},n.createElement("article",null,n.createElement(q,null),n.createElement(h,null),p&&n.createElement(B,{toc:t.toc,minHeadingLevel:o,maxHeadingLevel:m,className:(0,l.Z)(u.kM.docs.docTocMobile,V)}),n.createElement("div",{className:(0,l.Z)(u.kM.docs.docMarkdown,"markdown")},v&&n.createElement("header",null,n.createElement(D.Z,{as:"h1"},d)),n.createElement(J.Z,null,n.createElement(t,null))),n.createElement(T,e)),n.createElement(c,{previous:a.previous,next:a.next}))),E&&n.createElement("div",{className:"col col--3"},n.createElement(y.Z,{toc:t.toc,minHeadingLevel:o,maxHeadingLevel:m,className:u.kM.docs.docTocDesktop})))}function j(e){var t="docs-doc-id-"+e.content.metadata.unversionedId;return n.createElement(u.FG,{className:t},n.createElement(X,e),n.createElement(Q,e))}},6753:function(e,t,a){a.d(t,{Z:function(){return u}});var n=a(7294),l=a(5999),r=a(7462),i=a(3366),s=a(6010),c="iconEdit_dcUD",o=["className"];function m(e){var t=e.className,a=(0,i.Z)(e,o);return n.createElement("svg",(0,r.Z)({fill:"currentColor",height:"20",width:"20",viewBox:"0 0 40 40",className:(0,s.Z)(c,t),"aria-hidden":"true"},a),n.createElement("g",null,n.createElement("path",{d:"m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"})))}var d=a(5979);function u(e){var t=e.editUrl;return n.createElement("a",{href:t,target:"_blank",rel:"noreferrer noopener",className:d.kM.common.editThisPage},n.createElement(m,null),n.createElement(l.Z,{id:"theme.common.editThisPage",description:"The link label to edit the current page"},"Edit this page"))}},1750:function(e,t,a){a.d(t,{Z:function(){return r}});var n=a(7294),l=a(9960);function r(e){var t=e.permalink,a=e.title,r=e.subLabel;return n.createElement(l.Z,{className:"pagination-nav__link",to:t},r&&n.createElement("div",{className:"pagination-nav__sublabel"},r),n.createElement("div",{className:"pagination-nav__label"},a))}},1575:function(e,t,a){a.d(t,{Z:function(){return m}});var n=a(7462),l=a(3366),r=a(7294),i=a(6010),s=a(5002),c="tableOfContents_cNA8",o=["className"];function m(e){var t=e.className,a=(0,l.Z)(e,o);return r.createElement("div",{className:(0,i.Z)(c,"thin-scrollbar",t)},r.createElement(s.Z,(0,n.Z)({},a,{linkClassName:"table-of-contents__link toc-highlight",linkActiveClassName:"table-of-contents__link--active"})))}},5002:function(e,t,a){a.d(t,{Z:function(){return o}});var n=a(7462),l=a(3366),r=a(7294),i=a(5979),s=["toc","className","linkClassName","linkActiveClassName","minHeadingLevel","maxHeadingLevel"];function c(e){var t=e.toc,a=e.className,n=e.linkClassName,l=e.isChild;return t.length?r.createElement("ul",{className:l?void 0:a},t.map((function(e){return r.createElement("li",{key:e.id},r.createElement("a",{href:"#"+e.id,className:null!=n?n:void 0,dangerouslySetInnerHTML:{__html:e.value}}),r.createElement(c,{isChild:!0,toc:e.children,className:a,linkClassName:n}))}))):null}function o(e){var t=e.toc,a=e.className,o=void 0===a?"table-of-contents table-of-contents__left-border":a,m=e.linkClassName,d=void 0===m?"table-of-contents__link":m,u=e.linkActiveClassName,v=void 0===u?void 0:u,b=e.minHeadingLevel,p=e.maxHeadingLevel,E=(0,l.Z)(e,s),g=(0,i.LU)(),h=null!=b?b:g.tableOfContents.minHeadingLevel,f=null!=p?p:g.tableOfContents.maxHeadingLevel,N=(0,i.b9)({toc:t,minHeadingLevel:h,maxHeadingLevel:f}),_=(0,r.useMemo)((function(){if(d&&v)return{linkClassName:d,linkActiveClassName:v,minHeadingLevel:h,maxHeadingLevel:f}}),[d,v,h,f]);return(0,i.Si)(_),r.createElement(c,(0,n.Z)({toc:N,className:o,linkClassName:d},E))}},7774:function(e,t,a){a.d(t,{Z:function(){return o}});var n=a(7294),l=a(6010),r=a(9960),i="tag_hD8n",s="tagRegular_D6E_",c="tagWithCount_i0QQ";function o(e){var t=e.permalink,a=e.name,o=e.count;return n.createElement(r.Z,{href:t,className:(0,l.Z)(i,o?c:s)},a,o&&n.createElement("span",null,o))}},62:function(e,t,a){a.d(t,{Z:function(){return o}});var n=a(7294),l=a(6010),r=a(5999),i=a(7774),s="tags_XVD_",c="tag_JSN8";function o(e){var t=e.tags;return n.createElement(n.Fragment,null,n.createElement("b",null,n.createElement(r.Z,{id:"theme.tags.tagsListLabel",description:"The label alongside a tag list"},"Tags:")),n.createElement("ul",{className:(0,l.Z)(s,"padding--none","margin-left--sm")},t.map((function(e){var t=e.label,a=e.permalink;return n.createElement("li",{key:a,className:c},n.createElement(i.Z,{name:t,permalink:a}))}))))}}}]);
\ No newline at end of file
diff --git a/assets/js/1be78505.660ad521.js b/assets/js/1be78505.660ad521.js
new file mode 100644
index 0000000..09d7bb0
--- /dev/null
+++ b/assets/js/1be78505.660ad521.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([[514,75],{1579:function(e,t,a){a.r(t),a.d(t,{default:function(){return ee}});var n=a(7294),l=a(8790),r=a(2600),o=a(5979),i=a(6010),c=a(5537),s=a(7462);function d(e){return n.createElement("svg",(0,s.Z)({width:"20",height:"20","aria-hidden":"true"},e),n.createElement("g",{fill:"#7a7a7a"},n.createElement("path",{d:"M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"}),n.createElement("path",{d:"M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"})))}var u=a(5999),m="collapseSidebarButton_FykI",b="collapseSidebarButtonIcon_DTRl";function p(e){var t=e.onClick;return n.createElement("button",{type:"button",title:(0,u.I)({id:"theme.docs.sidebar.collapseButtonTitle",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),"aria-label":(0,u.I)({id:"theme.docs.sidebar.collapseButtonAriaLabel",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),className:(0,i.Z)("button button--secondary button--outline",m),onClick:t},n.createElement(d,{className:b}))}var f=a(3366),v=a(9960),h=a(3919),E=a(541),_="menuHtmlItem_fVIQ",g="menuExternalLink_tcZa",k=a(2389),C=["item"],S=["item","onItemClick","activePath","level","index"],I=["item","onItemClick","activePath","level","index"];function N(e){var t=e.item,a=(0,f.Z)(e,C);switch(t.type){case"category":return n.createElement(Z,(0,s.Z)({item:t},a));case"html":return n.createElement(T,(0,s.Z)({item:t},a));default:return n.createElement(M,(0,s.Z)({item:t},a))}}function Z(e){var t=e.item,a=e.onItemClick,l=e.activePath,r=e.level,c=e.index,d=(0,f.Z)(e,S),m=t.items,b=t.label,p=t.collapsible,h=t.className,E=t.href,_=function(e){var t=(0,k.Z)();return(0,n.useMemo)((function(){return e.href?e.href:!t&&e.collapsible?(0,o.Wl)(e):void 0}),[e,t])}(t),g=(0,o._F)(t,l),C=(0,o.Mg)(E,l),I=(0,o.uR)({initialState:function(){return!!p&&(!g&&t.collapsed)}}),N=I.collapsed,Z=I.setCollapsed;!function(e){var t=e.isActive,a=e.collapsed,l=e.setCollapsed,r=(0,o.D9)(t);(0,n.useEffect)((function(){t&&!r&&a&&l(!1)}),[t,r,a,l])}({isActive:g,collapsed:N,setCollapsed:Z});var T=(0,o.fP)(),M=T.expandedItem,y=T.setExpandedItem;function L(e){void 0===e&&(e=!N),y(e?null:c),Z(e)}var A=(0,o.LU)().autoCollapseSidebarCategories;return(0,n.useEffect)((function(){p&&M&&M!==c&&A&&Z(!0)}),[p,M,c,Z,A]),n.createElement("li",{className:(0,i.Z)(o.kM.docs.docSidebarItemCategory,o.kM.docs.docSidebarItemCategoryLevel(r),"menu__list-item",{"menu__list-item--collapsed":N},h)},n.createElement("div",{className:(0,i.Z)("menu__list-item-collapsible",{"menu__list-item-collapsible--active":C})},n.createElement(v.Z,(0,s.Z)({className:(0,i.Z)("menu__link",{"menu__link--sublist":p,"menu__link--sublist-caret":!E,"menu__link--active":g}),onClick:p?function(e){null==a||a(t),E?L(!1):(e.preventDefault(),L())}:function(){null==a||a(t)},"aria-current":C?"page":void 0,"aria-expanded":p?!N:void 0,href:p?null!=_?_:"#":_},d),b),E&&p&&n.createElement("button",{"aria-label":(0,u.I)({id:"theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel",message:"Toggle the collapsible sidebar category '{label}'",description:"The ARIA label to toggle the collapsible sidebar category"},{label:b}),type:"button",className:"clean-btn menu__caret",onClick:function(e){e.preventDefault(),L()}})),n.createElement(o.zF,{lazy:!0,as:"ul",className:"menu__list",collapsed:N},n.createElement(x,{items:m,tabIndex:N?-1:0,onItemClick:a,activePath:l,level:r+1})))}function T(e){var t=e.item,a=e.level,l=e.index,r=t.value,c=t.defaultStyle,s=t.className;return n.createElement("li",{className:(0,i.Z)(o.kM.docs.docSidebarItemLink,o.kM.docs.docSidebarItemLinkLevel(a),c&&_+" menu__list-item",s),key:l,dangerouslySetInnerHTML:{__html:r}})}function M(e){var t=e.item,a=e.onItemClick,l=e.activePath,r=e.level,c=(e.index,(0,f.Z)(e,I)),d=t.href,u=t.label,m=t.className,b=(0,o._F)(t,l),p=(0,h.Z)(d);return n.createElement("li",{className:(0,i.Z)(o.kM.docs.docSidebarItemLink,o.kM.docs.docSidebarItemLinkLevel(r),"menu__list-item",m),key:u},n.createElement(v.Z,(0,s.Z)({className:(0,i.Z)("menu__link",!p&&g,{"menu__link--active":b}),"aria-current":b?"page":void 0,to:d},p&&{onClick:a?function(){return a(t)}:void 0},c),u,!p&&n.createElement(E.Z,null)))}var y=["items"];function L(e){var t=e.items,a=(0,f.Z)(e,y);return n.createElement(o.D_,null,t.map((function(e,t){return n.createElement(N,(0,s.Z)({key:t,item:e,index:t},a))})))}var x=(0,n.memo)(L),A="menu_izAj",w="menuWithAnnouncementBar_l2a_";function F(e){var t=e.path,a=e.sidebar,l=e.className,r=function(){var e=(0,o.nT)().isActive,t=(0,n.useState)(e),a=t[0],l=t[1];return(0,o.RF)((function(t){var a=t.scrollY;e&&l(0===a)}),[e]),e&&a}();return n.createElement("nav",{className:(0,i.Z)("menu thin-scrollbar",A,r&&w,l)},n.createElement("ul",{className:(0,i.Z)(o.kM.docs.docSidebarMenu,"menu__list")},n.createElement(x,{items:a,activePath:t,level:1})))}var P="sidebar_RiAD",B="sidebarWithHideableNavbar_d0QC",D="sidebarHidden_Lg_2",R="sidebarLogo_YUvz";function H(e){var t=e.path,a=e.sidebar,l=e.onCollapse,r=e.isHidden,s=(0,o.LU)(),d=s.navbar.hideOnScroll,u=s.hideableSidebar;return n.createElement("div",{className:(0,i.Z)(P,d&&B,r&&D)},d&&n.createElement(c.Z,{tabIndex:-1,className:R}),n.createElement(F,{path:t,sidebar:a}),u&&n.createElement(p,{onClick:l}))}var W=n.memo(H),z=function(e){var t=e.sidebar,a=e.path,l=(0,o.el)();return n.createElement("ul",{className:(0,i.Z)(o.kM.docs.docSidebarMenu,"menu__list")},n.createElement(x,{items:t,activePath:a,onItemClick:function(e){"category"===e.type&&e.href&&l.toggle(),"link"===e.type&&l.toggle()},level:1}))};function Y(e){return n.createElement(o.Zo,{component:z,props:e})}var q=n.memo(Y);function U(e){var t=(0,o.iP)(),a="desktop"===t||"ssr"===t,l="mobile"===t;return n.createElement(n.Fragment,null,a&&n.createElement(W,e),l&&n.createElement(q,e))}var V=a(4608),G="backToTopButton_RiI4",K="backToTopButtonShow_ssHd";function Q(){var e=(0,n.useRef)(null);return{smoothScrollTop:function(){var t;e.current=(t=null,function e(){var a=document.documentElement.scrollTop;a>0&&(t=requestAnimationFrame(e),window.scrollTo(0,Math.floor(.85*a)))}(),function(){return t&&cancelAnimationFrame(t)})},cancelScrollToTop:function(){return null==e.current?void 0:e.current()}}}function X(){var e=(0,n.useState)(!1),t=e[0],a=e[1],l=(0,n.useRef)(!1),r=Q(),c=r.smoothScrollTop,s=r.cancelScrollToTop;return(0,o.RF)((function(e,t){var n=e.scrollY,r=null==t?void 0:t.scrollY;if(r)if(l.current)l.current=!1;else{var o=n=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),l=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=l(e.components);return r.createElement(s.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),m=l(n),f=a,d=m["".concat(s,".").concat(f)]||m[f]||p[f]||o;return n?r.createElement(d,i(i({ref:t},u),{},{components:n})):r.createElement(d,i({ref:t},u))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=m;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c.mdxType="string"==typeof e?e:a,i[1]=c;for(var l=2;l\n")),(0,o.kt)("p",null,"Compound predicates (",(0,o.kt)("inlineCode",{parentName:"p"},"_any")," & ",(0,o.kt)("inlineCode",{parentName:"p"},"_all"),") may be removed by passing the option ",(0,o.kt)("inlineCode",{parentName:"p"},"compounds: false"),"."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-erb"},"<%= f.predicate_select compounds: false %>\n")),(0,o.kt)("p",null,"Searchable attributes versus non-searchable ones may be specified as follows:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ruby"},"def self.ransackable_attributes(auth_object = nil)\n %w(searchable_attribute_1 searchable_attribute_2 ...) + _ransackers.keys\nend\n")))}f.isMDXComponent=!0}}]);
\ No newline at end of file
diff --git a/assets/js/31a91795.503f461d.js b/assets/js/31a91795.503f461d.js
new file mode 100644
index 0000000..79ca19f
--- /dev/null
+++ b/assets/js/31a91795.503f461d.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([[570],{713:function(e){e.exports=JSON.parse('{"permalink":"/ransack/blog","page":1,"postsPerPage":10,"totalPages":1,"totalCount":1,"blogDescription":"Blog","blogTitle":"Blog"}')}}]);
\ No newline at end of file
diff --git a/assets/js/393be207.fa4d0ba8.js b/assets/js/393be207.fa4d0ba8.js
new file mode 100644
index 0000000..d00e34b
--- /dev/null
+++ b/assets/js/393be207.fa4d0ba8.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([[414],{3905:function(e,t,n){n.d(t,{Zo:function(){return l},kt:function(){return m}});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function c(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var i=r.createContext({}),u=function(e){var t=r.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):c(c({},t),e)),n},l=function(e){var t=u(e.components);return r.createElement(i.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},s=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,i=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),s=u(n),m=o,d=s["".concat(i,".").concat(m)]||s[m]||f[m]||a;return n?r.createElement(d,c(c({ref:t},l),{},{components:n})):r.createElement(d,c({ref:t},l))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,c=new Array(a);c[0]=s;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p.mdxType="string"==typeof e?e:o,c[1]=p;for(var u=2;u=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r =0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var i=r.createContext({}),s=function(e){var t=r.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):c(c({},t),e)),n},u=function(e){var t=s(e.components);return r.createElement(i.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,i=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),m=s(n),d=o,y=m["".concat(i,".").concat(d)]||m[d]||p[d]||a;return n?r.createElement(y,c(c({ref:t},u),{},{components:n})):r.createElement(y,c({ref:t},u))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,c=new Array(a);c[0]=m;var l={};for(var i in t)hasOwnProperty.call(t,i)&&(l[i]=t[i]);l.originalType=e,l.mdxType="string"==typeof e?e:o,c[1]=l;for(var s=2;s0&&e[n-1]===t?e:e.concat(t)},g=function(e,t){var n=e.plain,r=Object.create(null),o=e.styles.reduce((function(e,n){var r=n.languages,o=n.style;return r&&!r.includes(t)||n.types.forEach((function(t){var n=d({},e[t],o);e[t]=n})),e}),r);return o.root=n,o.plain=d({},n,{backgroundColor:null}),o};function v(e,t){var n={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&-1===t.indexOf(r)&&(n[r]=e[r]);return n}var b=function(e){function t(){for(var t=this,n=[],r=arguments.length;r--;)n[r]=arguments[r];e.apply(this,n),m(this,"getThemeDict",(function(e){if(void 0!==t.themeDict&&e.theme===t.prevTheme&&e.language===t.prevLanguage)return t.themeDict;t.prevTheme=e.theme,t.prevLanguage=e.language;var n=e.theme?g(e.theme,e.language):void 0;return t.themeDict=n})),m(this,"getLineProps",(function(e){var n=e.key,r=e.className,o=e.style,a=d({},v(e,["key","className","style","line"]),{className:"token-line",style:void 0,key:void 0}),c=t.getThemeDict(t.props);return void 0!==c&&(a.style=c.plain),void 0!==o&&(a.style=void 0!==a.style?d({},a.style,o):o),void 0!==n&&(a.key=n),r&&(a.className+=" "+r),a})),m(this,"getStyleForToken",(function(e){var n=e.types,r=e.empty,o=n.length,a=t.getThemeDict(t.props);if(void 0!==a){if(1===o&&"plain"===n[0])return r?{display:"inline-block"}:void 0;if(1===o&&!r)return a[n[0]];var c=r?{display:"inline-block"}:{},l=n.map((function(e){return a[e]}));return Object.assign.apply(Object,[c].concat(l))}})),m(this,"getTokenProps",(function(e){var n=e.key,r=e.className,o=e.style,a=e.token,c=d({},v(e,["key","className","style","token"]),{className:"token "+a.types.join(" "),children:a.content,style:t.getStyleForToken(a),key:void 0});return void 0!==o&&(c.style=void 0!==c.style?d({},c.style,o):o),void 0!==n&&(c.key=n),r&&(c.className+=" "+r),c})),m(this,"tokenize",(function(e,t,n,r){var o={code:t,grammar:n,language:r,tokens:[]};e.hooks.run("before-tokenize",o);var a=o.tokens=e.tokenize(o.code,o.grammar,o.language);return e.hooks.run("after-tokenize",o),a}))}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.render=function(){var e=this.props,t=e.Prism,n=e.language,r=e.code,o=e.children,a=this.getThemeDict(this.props),c=t.languages[n];return o({tokens:function(e){for(var t=[[]],n=[e],r=[0],o=[e.length],a=0,c=0,l=[],i=[l];c>-1;){for(;(a=r[c]++)0?u:["plain"],s=p):(u=h(u,p.type),p.alias&&(u=h(u,p.alias)),s=p.content),"string"==typeof s){var m=s.split(y),d=m.length;l.push({types:u,content:m[0]});for(var g=1;g0&&(l=c.getRangeAt(0)),r.append(o),o.select(),o.selectionStart=0,o.selectionEnd=e.length;var i=!1;try{i=document.execCommand("copy")}catch(s){}o.remove(),l&&(c.removeAllRanges(),c.addRange(l)),a&&a.focus()}(t),a(!0),c.current=window.setTimeout((function(){a(!1)}),1e3)}),[t]);return(0,r.useEffect)((function(){return function(){return window.clearTimeout(c.current)}}),[]),r.createElement("button",{type:"button","aria-label":o?(0,O.I)({id:"theme.CodeBlock.copied",message:"Copied",description:"The copied button label on code blocks"}):(0,O.I)({id:"theme.CodeBlock.copyButtonAriaLabel",message:"Copy code to clipboard",description:"The ARIA label for copy code blocks button"}),title:(0,O.I)({id:"theme.CodeBlock.copy",message:"Copy",description:"The copy button label on code blocks"}),className:(0,s.Z)(N,"clean-btn",o&&T),onClick:l},r.createElement("span",{className:Z,"aria-hidden":"true"},r.createElement("svg",{className:j,viewBox:"0 0 24 24"},r.createElement("path",{d:"M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"})),r.createElement("svg",{className:w,viewBox:"0 0 24 24"},r.createElement("path",{d:"M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"}))))}var P="codeBlockContainer_I0IT",C="codeBlockContent_wNvx",_="codeBlockTitle_BvAR",B="codeBlock_jd64",L="codeBlockStandalone_csWH",A="codeBlockLines_mRuA";function S(e){var t,n=e.children,o=e.className,c=void 0===o?"":o,l=e.metastring,i=e.title,u=e.language,m=(0,E.LU)().prism,d=(0,r.useState)(!1),y=d[0],f=d[1];(0,r.useEffect)((function(){f(!0)}),[]);var h=(0,E.bc)(l)||i,g=(0,E.pJ)();if(r.Children.toArray(n).some((function(e){return(0,r.isValidElement)(e)})))return r.createElement(k,(0,a.Z)({},p,{key:String(y),theme:g,code:"",language:"text"}),(function(e){var t=e.className,o=e.style;return r.createElement("pre",{tabIndex:0,className:(0,s.Z)(t,L,"thin-scrollbar",P,c,E.kM.common.codeBlock),style:o},r.createElement("code",{className:A},n))}));var v=Array.isArray(n)?n.join(""):n,b=null!=(t=null!=u?u:(0,E.Vo)(c))?t:m.defaultLanguage,O=(0,E.nZ)(v,l,b),N=O.highlightLines,T=O.code;return r.createElement(k,(0,a.Z)({},p,{key:String(y),theme:g,code:T,language:null!=b?b:"text"}),(function(e){var t,n=e.className,o=e.style,l=e.tokens,i=e.getLineProps,u=e.getTokenProps;return r.createElement("div",{className:(0,s.Z)(P,c,(t={},t["language-"+b]=b&&!c.includes("language-"+b),t),E.kM.common.codeBlock)},h&&r.createElement("div",{style:o,className:_},h),r.createElement("div",{className:C,style:o},r.createElement("pre",{tabIndex:0,className:(0,s.Z)(n,B,"thin-scrollbar")},r.createElement("code",{className:A},l.map((function(e,t){1===e.length&&"\n"===e[0].content&&(e[0].content="");var n=i({line:e,key:t});return N.includes(t)&&(n.className+=" docusaurus-highlight-code-line"),r.createElement("span",(0,a.Z)({key:t},n),e.map((function(e,t){return r.createElement("span",(0,a.Z)({key:t},u({token:e,key:t})))})),r.createElement("br",null))})))),r.createElement(x,{code:T})))}))}var D=n(9960);var I="details_BAp3";function V(e){var t=Object.assign({},e);return r.createElement(E.PO,(0,a.Z)({},t,{className:(0,s.Z)("alert alert--info",I,t.className)}))}var H=n(9649);function R(e){return r.createElement(H.Z,e)}var z="img_E7b_";var M={head:function(e){var t=r.Children.map(e.children,(function(e){return function(e){var t,n;if(null!=e&&null!=(t=e.props)&&t.mdxType&&null!=e&&null!=(n=e.props)&&n.originalType){var o=e.props,a=(o.mdxType,o.originalType,(0,c.Z)(o,i));return r.createElement(e.props.originalType,a)}return e}(e)}));return r.createElement(l.Z,e,t)},code:function(e){var t=["a","b","big","i","span","em","strong","sup","sub","small"];return r.Children.toArray(e.children).every((function(e){return"string"==typeof e&&!e.includes("\n")||(0,r.isValidElement)(e)&&t.includes(e.props.mdxType)}))?r.createElement("code",e):r.createElement(S,e)},a:function(e){return r.createElement(D.Z,e)},pre:function(e){var t;return r.createElement(S,(0,r.isValidElement)(e.children)&&"code"===e.children.props.originalType?null==(t=e.children)?void 0:t.props:Object.assign({},e))},details:function(e){var t=r.Children.toArray(e.children),n=t.find((function(e){var t;return"summary"===(null==e||null==(t=e.props)?void 0:t.mdxType)})),o=r.createElement(r.Fragment,null,t.filter((function(e){return e!==n})));return r.createElement(V,(0,a.Z)({},e,{summary:n}),o)},ul:function(e){return r.createElement("ul",(0,a.Z)({},e,{className:(t=e.className,(0,s.Z)(t,(null==t?void 0:t.includes("contains-task-list"))&&"contains-task-list_tsSF"))}));var t},img:function(e){return r.createElement("img",(0,a.Z)({loading:"lazy"},e,{className:(t=e.className,(0,s.Z)(t,z))}));var t},h1:function(e){return r.createElement(R,(0,a.Z)({as:"h1"},e))},h2:function(e){return r.createElement(R,(0,a.Z)({as:"h2"},e))},h3:function(e){return r.createElement(R,(0,a.Z)({as:"h3"},e))},h4:function(e){return r.createElement(R,(0,a.Z)({as:"h4"},e))},h5:function(e){return r.createElement(R,(0,a.Z)({as:"h5"},e))},h6:function(e){return r.createElement(R,(0,a.Z)({as:"h6"},e))}};function F(e){var t=e.children;return r.createElement(o.Zo,{components:M},t)}}}]);
\ No newline at end of file
diff --git a/assets/js/460f2046.61bc2c46.js b/assets/js/460f2046.61bc2c46.js
new file mode 100644
index 0000000..8ddf4df
--- /dev/null
+++ b/assets/js/460f2046.61bc2c46.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([[782],{3905:function(e,n,t){t.d(n,{Zo:function(){return p},kt:function(){return f}});var r=t(7294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var s=r.createContext({}),u=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=u(e.components);return r.createElement(s.Provider,{value:n},e.children)},l={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),d=u(t),f=o,m=d["".concat(s,".").concat(f)]||d[f]||l[f]||a;return t?r.createElement(m,i(i({ref:n},p),{},{components:t})):r.createElement(m,i({ref:n},p))}));function f(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=d;var c={};for(var s in n)hasOwnProperty.call(n,s)&&(c[s]=n[s]);c.originalType=e,c.mdxType="string"==typeof e?e:o,i[1]=c;for(var u=2;uUsers\n\n<%= search_form_for @q, url: dashboard_index_path do |f| %>\n <%= f.label :name_cont %>\n <%= f.search_field :name_cont %>\n\n <%= f.submit %>\n<% end %>\n\n\n <% @users.each do |user| %>\n <%= user.name %> [<%= user.devices.map {|device| device.name }.join(', ') %>] \n <% end %>\n \n\n<% if params[:q] %>\n <%= link_to 'Export 1', dashboard_index_path({name: params[:q][:name_cont]}.merge({format: :csv})) %>\n<% else %>\n <%= link_to 'Export 2', dashboard_index_path(format: 'csv') %>\n<% end %>\n")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx",metastring:"title='user.rb'",title:"'user.rb'"},"require 'csv'\n\nclass User < ApplicationRecord\n has_many :devices\n\n def self.get_csv(users)\n CSV.generate do |csv|\n csv << [\"Name\", \"Devices\"]\n\n users.each do |user|\n csv << [user.name, user.devices.map{|device| device.name}.join(', ')]\n end\n end\n end\nend\n")))}f.isMDXComponent=!0}}]);
\ No newline at end of file
diff --git a/assets/js/4eaee7fa.1654b667.js b/assets/js/4eaee7fa.1654b667.js
new file mode 100644
index 0000000..65e9271
--- /dev/null
+++ b/assets/js/4eaee7fa.1654b667.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([[719],{3905:function(e,t,r){r.d(t,{Zo:function(){return p},kt:function(){return f}});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(r),f=a,g=u["".concat(l,".").concat(f)]||u[f]||d[f]||i;return r?n.createElement(g,o(o({ref:t},p),{},{components:r})):n.createElement(g,o({ref:t},p))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var c=2;c
With 3.0.0 we are hoping to re-energise the community, we need help on closing out old issues, refactoring the codebase and even some design work.
I also wanted to let you know that Ernie Miller (creator of Ransack) has decided to leave the project completely, he has this message for the community:
While my own personal development efforts have been spent elsewhere as of late, I'm keenly aware of how many people still depend on some of the software I originally wrote all those years ago.
That's why I'm grateful to be able to step away from the ActiveRecord Hackery organization (and, specifically, maintenance of Ransack) without impacting those users. I'm thankful that Sean, David, Greg, and others will continue to support users, and wish them the best as they move forward without me!
Please join me in thanking Ernie for bringing Ransack to life, I personally think it is one of the most amazing Rails libraries out there.
]]>
+
+ Sean Carroll
+
+
+
+
+
\ No newline at end of file
diff --git a/blog/ransack-3-0-0.html b/blog/ransack-3-0-0.html
new file mode 100644
index 0000000..fc0181a
--- /dev/null
+++ b/blog/ransack-3-0-0.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Ransack 3.0.0 | Ransack documentation
+
+
+
+
+
+
Ransack has been a part of many Rubyists toolboxes for years and 3.0.0 is a major release. We have a number of new features and one breaking change. As part of 3.0.0, we decided to launch this documentation website, merging in the Wiki and the content from the README.
With 3.0.0 we are hoping to re-energise the community, we need help on closing out old issues, refactoring the codebase and even some design work.
I also wanted to let you know that Ernie Miller (creator of Ransack) has decided to leave the project completely, he has this message for the community:
While my own personal development efforts have been spent elsewhere as of late, I'm keenly aware of how many people still depend on some of the software I originally wrote all those years ago.
That's why I'm grateful to be able to step away from the ActiveRecord Hackery organization (and, specifically, maintenance of Ransack) without impacting those users. I'm thankful that Sean, David, Greg, and others will continue to support users, and wish them the best as they move forward without me!
Please join me in thanking Ernie for bringing Ransack to life, I personally think it is one of the most amazing Rails libraries out there.
+
+
+
+
\ No newline at end of file
diff --git a/blog/rss.xml b/blog/rss.xml
new file mode 100644
index 0000000..da6a519
--- /dev/null
+++ b/blog/rss.xml
@@ -0,0 +1,22 @@
+
+
+
+ Ransack documentation Blog
+ https://activerecord-hackery.github.io/ransack/blog
+ Ransack documentation Blog
+ Sun, 27 Mar 2022 00:00:00 GMT
+ https://validator.w3.org/feed/docs/rss2.html
+ https://github.com/jpmonette/feed
+ en
+ -
+
+ https://activerecord-hackery.github.io/ransack/blog/ransack-3-0-0
+ ransack-3-0-0
+ Sun, 27 Mar 2022 00:00:00 GMT
+
+ Ransack has been a part of many Rubyists toolboxes for years and 3.0.0 is a major release. We have a number of new features and one breaking change. As part of 3.0.0, we decided to launch this documentation website, merging in the Wiki and the content from the README.With 3.0.0 we are hoping to re-energise the community, we need help on closing out old issues, refactoring the codebase and even some design work.
I also wanted to let you know that Ernie Miller (creator of Ransack) has decided to leave the project completely, he has this message for the community:
While my own personal development efforts have been spent elsewhere as of late, I'm keenly aware of how many people still depend on some of the software I originally wrote all those years ago.
That's why I'm grateful to be able to step away from the ActiveRecord Hackery organization (and, specifically, maintenance of Ransack) without impacting those users. I'm thankful that Sean, David, Greg, and others will continue to support users, and wish them the best as they move forward without me!
Please join me in thanking Ernie for bringing Ransack to life, I personally think it is one of the most amazing Rails libraries out there.
]]>
+ ransack
+ release
+
+
+
\ No newline at end of file
diff --git a/blog/tags.html b/blog/tags.html
new file mode 100644
index 0000000..a129655
--- /dev/null
+++ b/blog/tags.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Tags | Ransack documentation
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/blog/tags/ransack.html b/blog/tags/ransack.html
new file mode 100644
index 0000000..ee21a8d
--- /dev/null
+++ b/blog/tags/ransack.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+One post tagged with "ransack" | Ransack documentation
+
+
+
+
+
+
Ransack has been a part of many Rubyists toolboxes for years and 3.0.0 is a major release. We have a number of new features and one breaking change. As part of 3.0.0, we decided to launch this documentation website, merging in the Wiki and the content from the README.
With 3.0.0 we are hoping to re-energise the community, we need help on closing out old issues, refactoring the codebase and even some design work.
I also wanted to let you know that Ernie Miller (creator of Ransack) has decided to leave the project completely, he has this message for the community:
While my own personal development efforts have been spent elsewhere as of late, I'm keenly aware of how many people still depend on some of the software I originally wrote all those years ago.
That's why I'm grateful to be able to step away from the ActiveRecord Hackery organization (and, specifically, maintenance of Ransack) without impacting those users. I'm thankful that Sean, David, Greg, and others will continue to support users, and wish them the best as they move forward without me!
Please join me in thanking Ernie for bringing Ransack to life, I personally think it is one of the most amazing Rails libraries out there.
+
+
+
+
\ No newline at end of file
diff --git a/blog/tags/release.html b/blog/tags/release.html
new file mode 100644
index 0000000..1c9e49f
--- /dev/null
+++ b/blog/tags/release.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+One post tagged with "release" | Ransack documentation
+
+
+
+
+
+
Ransack has been a part of many Rubyists toolboxes for years and 3.0.0 is a major release. We have a number of new features and one breaking change. As part of 3.0.0, we decided to launch this documentation website, merging in the Wiki and the content from the README.
With 3.0.0 we are hoping to re-energise the community, we need help on closing out old issues, refactoring the codebase and even some design work.
I also wanted to let you know that Ernie Miller (creator of Ransack) has decided to leave the project completely, he has this message for the community:
While my own personal development efforts have been spent elsewhere as of late, I'm keenly aware of how many people still depend on some of the software I originally wrote all those years ago.
That's why I'm grateful to be able to step away from the ActiveRecord Hackery organization (and, specifically, maintenance of Ransack) without impacting those users. I'm thankful that Sean, David, Greg, and others will continue to support users, and wish them the best as they move forward without me!
Please join me in thanking Ernie for bringing Ransack to life, I personally think it is one of the most amazing Rails libraries out there.
+
+
+
+
\ No newline at end of file
diff --git a/getting-started/advanced-mode.html b/getting-started/advanced-mode.html
new file mode 100644
index 0000000..f704e4b
--- /dev/null
+++ b/getting-started/advanced-mode.html
@@ -0,0 +1,26 @@
+
+
+
+
+
+
+
+Advanced Mode | Ransack documentation
+
+
+
+
+
+
🏠 Getting started Advanced Mode On this page
"Advanced" searches Rails's nested attributes functionality in order to
+generate complex queries with nested AND/OR groupings, etc. This takes a bit
+more work but can generate some pretty cool search interfaces that put a lot of
+power in the hands of your users.
A notable drawback with these searches is
+that the increased size of the parameter string will typically force you to use
+the HTTP POST method instead of GET.
Tweak your routes resources :people do collection do match 'search' => 'people#search', via: [:get, :post], as: :search end end
Add a controller action def search index render :index end
<%= search_form_for @q, url: search_people_path, html: { method: :post } do |f| %>
Once you've done so, you can make use of the helpers in Ransack::Helpers::FormBuilder to
+construct much more complex search forms, such as the one on the
+demo app
+(source code here ).
+
+
+
+
\ No newline at end of file
diff --git a/getting-started/configuration.html b/getting-started/configuration.html
new file mode 100644
index 0000000..f2ccb37
--- /dev/null
+++ b/getting-started/configuration.html
@@ -0,0 +1,19 @@
+
+
+
+
+
+
+
+Configuration | Ransack documentation
+
+
+
+
+
+
🏠 Getting started Configuration On this page
Ransack may be easily configured. The best place to put configuration is in an initializer file at config/initializers/ransack.rb
, containing code such as:
Ransack.configure do |config| # Change default search parameter key name. # Default key name is :q config.search_key = :query # Raise errors if a query contains an unknown predicate or attribute. # Default is true (do not raise error on unknown conditions). config.ignore_unknown_conditions = false # Globally display sort links without the order indicator arrow. # Default is false (sort order indicators are displayed). # This can also be configured individually in each sort link (see the README). config.hide_sort_order_indicators = true end
Custom search parameter key name Sometimes there are situations when the default search parameter name cannot be used, for instance,
+if there are two searches on one page. Another name may be set using the search_key
option in the ransack
or search
methods in the controller, and in the @search_form_for
method in the view.
In the controller @search = Log.ransack(params[:log_search], search_key: :log_search) # or @search = Log.search(params[:log_search], search_key: :log_search)
In the view <%= f.search_form_for @search, as: :log_search %> <%= sort_link(@search) %>
+
+
+
+
\ No newline at end of file
diff --git a/getting-started/search-matches.html b/getting-started/search-matches.html
new file mode 100644
index 0000000..bc24656
--- /dev/null
+++ b/getting-started/search-matches.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Search Matchers | Ransack documentation
+
+
+
+
+
+
🏠 Getting started Search Matchers On this page
Search Matchers List of all possible predicates
Predicate Description Notes *_eq
equal *_not_eq
not equal *_matches
matches with LIKE
e.g. q[email_matches]=%@gmail.com
*_does_not_match
does not match with LIKE
*_matches_any
Matches any *_matches_all
Matches all *_does_not_match_any
Does not match any *_does_not_match_all
Does not match all *_lt
less than *_lteq
less than or equal *_gt
greater than *_gteq
greater than or equal *_present
not null and not empty Only compatible with string columns. Example: q[name_present]=1
(SQL: col is not null AND col != ''
) *_blank
is null or empty. (SQL: col is null OR col = ''
) *_null
is null *_not_null
is not null *_in
match any values in array e.g. q[name_in][]=Alice&q[name_in][]=Bob
*_not_in
match none of values in array *_lt_any
Less than any SQL: col < value1 OR col < value2
*_lteq_any
Less than or equal to any *_gt_any
Greater than any *_gteq_any
Greater than or equal to any *_lt_all
Less than all SQL: col < value1 AND col < value2
*_lteq_all
Less than or equal to all *_gt_all
Greater than all *_gteq_all
Greater than or equal to all *_not_eq_all
none of values in a set *_start
Starts with SQL: col LIKE 'value%'
*_not_start
Does not start with *_start_any
Starts with any of *_start_all
Starts with all of *_not_start_any
Does not start with any of *_not_start_all
Does not start with all of *_end
Ends with SQL: col LIKE '%value'
*_not_end
Does not end with *_end_any
Ends with any of *_end_all
Ends with all of *_not_end_any
*_not_end_all
*_cont
Contains value uses LIKE
*_cont_any
Contains any of *_cont_all
Contains all of *_not_cont
Does not contain *_not_cont_any
Does not contain any of *_not_cont_all
Does not contain all of *_i_cont
Contains value with case insensitive uses ILIKE
*_i_cont_any
Contains any of values with case insensitive *_i_cont_all
Contains all of values with case insensitive *_not_i_cont
Does not contain with case insensitive *_not_i_cont_any
Does not contain any of values with case insensitive *_not_i_cont_all
Does not contain all of values with case insensitive *_true
is true *_false
is false
See full list: https://github.com/activerecord-hackery/ransack/blob/master/lib/ransack/locale/en.yml#L15
+
+
+
+
\ No newline at end of file
diff --git a/getting-started/simple-mode.html b/getting-started/simple-mode.html
new file mode 100644
index 0000000..257407d
--- /dev/null
+++ b/getting-started/simple-mode.html
@@ -0,0 +1,49 @@
+
+
+
+
+
+
+
+Simple mode | Ransack documentation
+
+
+
+
+
+
🏠 Getting started Simple mode On this page
Simple Mode Ransack can be used in one of two modes, simple or advanced. For
+searching/filtering not requiring complex boolean logic, Ransack's simple
+mode should meet your needs.
In your controller def index @q = Person . ransack ( params [ : q ] ) @people = @q . result ( distinct : true ) end
or without distinct: true
, for sorting on an associated table's columns (in
+this example, with preloading each Person's Articles and pagination):
def index @q = Person . ransack ( params [ : q ] ) @people = @q . result . includes ( : articles ) . page ( params [ : page ] ) end
Default search options Search parameter Ransack uses a default :q
param key for search params. This may be changed by
+setting the search_key
option in a Ransack initializer file (typically
+config/initializers/ransack.rb
):
Ransack . configure do | c | # Change default search parameter key name . # Default key name is : q c . search_key = : query end
String search After version 2.4.0 when searching a string query Ransack by default strips all whitespace around the query string.
+This may be disabled by setting the strip_whitespace
option in a Ransack initializer file:
Ransack . configure do | c | # Change whitespace stripping behaviour . # Default is true c . strip_whitespace = false end
In your view The two primary Ransack view helpers are search_form_for
and sort_link
,
+which are defined in
+Ransack::Helpers::FormHelper .
Ransack's search_form_for
helper replaces form_for
for creating the view search form
< %= search_form_for @q do | f | % > # Search if the name field contains ... < %= f . label : name_cont % > < %= f . search_field : name_cont % > # Search if an associated articles . title starts with ... < %= f . label : articles_title_start % > < %= f . search_field : articles_title_start % > # Attributes may be chained . Search multiple attributes for one value ... < %= f . label : name_or_description_or_email_or_articles_title_cont % > < %= f . search_field : name_or_description_or_email_or_articles_title_cont % > < %= f . submit % > < % end % >
The argument of f.search_field
has to be in this form:
+attribute_name[_or_attribute_name]..._predicate
where [_or_another_attribute_name]...
means any repetition of _or_
plus the name of the attribute.
cont
(contains) and start
(starts with) are just two of the available
+search predicates.
The search_form_for
answer format can be set like this:
< %= search_form_for ( @q , format : : pdf ) do | f | % > < %= search_form_for ( @q , format : : json ) do | f | % >
Search link helper Ransack's sort_link
helper creates table headers that are sortable links
< %= sort_link ( @q , : name ) % >
Additional options can be passed after the column parameter, like a different
+column title or a default sort order.
If the first option after the column parameter is a String, it's considered a
+custom label for the link:
< %= sort_link ( @q , : name , 'Last Name' , default_order : : desc ) % >
You can use a block if the link markup is hard to fit into the label parameter:
< %= sort_link ( @q , : name ) do % > < strong > Player Name </ strong > < % end % >
With a polymorphic association, you may need to specify the name of the link
+explicitly to avoid an uninitialized constant Model::Xxxable
error (see issue
+#421 ):
< %= sort_link ( @q , : xxxable_of_Ymodel_type_some_attribute , 'Attribute Name' ) % >
If the first option after the column parameter and/or the label parameter is an
+Array, it will be used for sorting on multiple fields:
< %= sort_link ( @q , : last_name , [ : last_name , 'first_name asc' ] , 'Last Name' ) % >
In the example above, clicking the link will sort by last_name
and then
+first_name
. Specifying the sort direction on a field in the array tells
+Ransack to always sort that particular field in the specified direction.
Multiple default_order
fields may also be specified with a trailing options
+Hash:
< %= sort_link ( @q , : last_name , % i ( last_name first_name ) , default_order : { last_name : 'asc' , first_name : 'desc' } ) % >
This example toggles the sort directions of both fields, by default
+initially sorting the last_name
field by ascending order, and the
+first_name
field by descending order.
In the case that you wish to sort by some complex value, such as the result
+of a SQL function, you may do so using scopes. In your model, define scopes
+whose names line up with the name of the virtual field you wish to sort by,
+as so:
class Person < ActiveRecord : : Base scope : sort_by_reverse_name_asc , lambda { order ( "REVERSE(name) ASC" ) } scope : sort_by_reverse_name_desc , lambda { order ( "REVERSE(name) DESC" ) } ...
and you can then sort by this virtual field:
< %= sort_link ( @q , : reverse_name ) % >
The trailing options Hash can also be used for passing additional options to the
+generated link, like class:
.
The sort link order indicator arrows may be globally customized by setting a
+custom_arrows
option in an initializer file like
+config/initializers/ransack.rb
.
You can also enable a default_arrow
which is displayed on all sortable fields
+which are not currently used in the sorting. This is disabled by default so
+nothing will be displayed:
Ransack . configure do | c | c . custom_arrows = { up_arrow : '<i class="custom-up-arrow-icon"></i>' , down_arrow : 'U+02193' , default_arrow : '<i class="default-arrow-icon"></i>' } end
All sort links may be displayed without the order indicator
+arrows by setting hide_sort_order_indicators
to true in the initializer file.
+Note that this hides the arrows even if they were customized:
Ransack . configure do | c | c . hide_sort_order_indicators = true end
Without setting it globally, individual sort links may be displayed without
+the order indicator arrow by passing hide_indicator: true
in the sort link:
< %= sort_link ( @q , : name , hide_indicator : true ) % >
sort_url Ransack's sort_url
helper is like a sort_link
but returns only the url
sort_url
has the same API as sort_link
:
< %= sort_url ( @q , : name , default_order : : desc ) % >
< %= sort_url ( @q , : last_name , [ : last_name , 'first_name asc' ] ) % >
< %= sort_url ( @q , : last_name , % i ( last_name first_name ) , default_order : { last_name : 'asc' , first_name : 'desc' } ) % >
PostgreSQL's sort option The NULLS FIRST
and NULLS LAST
options can be used to determine whether nulls appear before or after non-null values in the sort ordering.
You may want to configure it like this:
Ransack . configure do | c | c . postgres_fields_sort_option = : nulls_first # or : nulls_last end
To treat nulls as having the lowest or highest value respectively. To force nulls to always be first or last, use
Ransack . configure do | c | c . postgres_fields_sort_option = : nulls_always_first # or : nulls_always_last end
See this feature: https://www.postgresql.org/docs/13/queries-order.html
Case Insensitive Sorting in PostgreSQL In order to request PostgreSQL to do a case insensitive sort for all string columns of a model at once, Ransack can be extended by using this approach:
module RansackObject def self . included ( base ) base . columns . each do | column | if column . type == : string base . ransacker column . name . to_sym , type : : string do Arel . sql ( "lower(#{base.table_name}.#{column.name})" ) end end end end end
class UserWithManyAttributes < ActiveRecord : : Base include RansackObject end
If this approach is taken, it is advisable to add a functional index .
This was originally asked in a Ransack issue and a solution was found on Stack Overflow .
+
+
+
+
\ No newline at end of file
diff --git a/getting-started/sorting.html b/getting-started/sorting.html
new file mode 100644
index 0000000..a1ffd36
--- /dev/null
+++ b/getting-started/sorting.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Sorting | Ransack documentation
+
+
+
+
+
+
On this page
Sorting Sorting in the View You can add a form to capture sorting and filtering options together.
< div class = " filters " id = " filtersSidebar " > < header class = " filters-header " > < div class = " filters-header-content " > < h3 > Filters </ h3 > </ div > </ header > < div class = " filters-content " > <%= search_form_for @q, class: 'form', url: articles_path, html: { autocomplete : 'off' , autocapitalize : 'none' } do |f| %> < div class = " form-group " > <%= f.label :title_cont, t('Filter_by_keyword') %> <%= f.search_field :title_cont %> </ div > <%= render partial: 'filters/date_title_sort', locals: { f : f } %> < div class = " form-group " > <%= f.label :grade_level_gteq, t('Grade_level') %> >= <%= f.search_field :grade_level_gteq %> </ div > < div class = " form-group " > <%= f.label :readability_gteq, t('Readability') %> >= <%= f.search_field :readability_gteq %> </ div > < div class = " form-group " > < i > <%= @articles.total_count %> articles </ i > </ div > < div class = " form-group " > < hr /> < div class = " filters-header-content " > <%= link_to request.path, class: 'form-link' do %> < i class = " far fa-undo icon-l " > </ i > <%= t('Clear_all') %> <% end %> <%= f.submit t('Filter'), class: 'btn btn-primary' %> </ div > </ div > <% end %> </ div > </ div >
Sorting in the Controller To specify a default search sort field + order in the controller index
:
@search = Post.ransack(params[:q]) @search.sorts = 'name asc' if @search.sorts.empty? @posts = @search.result.paginate(page: params[:page], per_page: 20)
Multiple sorts can be set by:
@search = Post.ransack(params[:q]) @search.sorts = ['name asc', 'created_at desc'] if @search.sorts.empty? @posts = @search.result.paginate(page: params[:page], per_page: 20)
+
+
+
+
\ No newline at end of file
diff --git a/getting-started/using-predicates.html b/getting-started/using-predicates.html
new file mode 100644
index 0000000..2b4bf30
--- /dev/null
+++ b/getting-started/using-predicates.html
@@ -0,0 +1,28 @@
+
+
+
+
+
+
+
+Using Predicates | Ransack documentation
+
+
+
+
+
+
🏠 Getting started Using Predicates On this page
The primary method of searching in Ransack is by using what is known as predicates .
Predicates are used within Ransack search queries to determine what information to
+match. For instance, the cont
predicate will check to see if an attribute called
+"first_name" contains a value using a wildcard query:
>> User.ransack(first_name_cont: 'Rya').result.to_sql => SELECT "users".* FROM "users" WHERE ("users"."first_name" LIKE '%Rya%')
You can also combine predicates for OR queries:
>> User.ransack(first_name_or_last_name_cont: 'Rya').result.to_sql => SELECT "users".* FROM "users" WHERE ("users"."first_name" LIKE '%Rya%' OR "users"."last_name" LIKE '%Rya%')
The syntax for OR
queries on an associated model is not immediately obvious, but makes sense. Assuming a User
has_one
Account
and the Account
has attributes
foo
and bar
:
>> User.ransack(account_foo_or_account_bar: 'val').result.to_sql => SELECT "users".* FROM "users" INNER JOIN accounts ON accounts.user_id = users.id WHERE ("accounts.foo LIKE '%val%' OR accounts.bar LIKE '%val%')
Below is a list of the built-in predicates of Ransack and their opposites. You may already
+be familiar with some of the predicates, as they also exist in the ARel library.
If you want to add your own, please
+see the [[Custom-Predicates|Custom Predicates]] page.
Please note: any attempt to use a predicate for an attribute that does not exist will
+silently fail . For instance, this will not work when there is no name
attribute:
>> User.ransack(name_cont: 'Rya').result.to_sql => "SELECT "users".* FROM "users"
eq (equals) The eq
predicate returns all records where a field is exactly equal to a given value:
>> User.ransack(first_name_eq: 'Ryan').result.to_sql => SELECT "users".* FROM "users" WHERE "users"."first_name" = 'Ryan'
Opposite: not_eq
matches The matches
predicate returns all records where a field is like a given value:
>> User.ransack(first_name_matches: 'Ryan').result.to_sql => SELECT "users".* FROM "users" WHERE ("users"."first_name" LIKE 'Ryan')
On Postgres, the case-insensitive ILIKE will be used.
Opposite: does_not_match
Note: If you want to do wildcard matching, you may be looking for the cont
/not_cont
+predicates instead.
lt (less than) The lt
predicate returns all records where a field is less than a given value:
>> User.ransack(age_lt: 25).result.to_sql => SELECT "users".* FROM "users" WHERE ("users"."age" < 25)
Opposite: gteq
(greater than or equal to)
lteq (less than or equal to) The lteq
predicate returns all records where a field is less than or equal to a given value:
>> User.ransack(age_lteq: 25).result.to_sql => SELECT "users".* FROM "users" WHERE ("users"."age" <= 25)
Opposite: gt
(greater than)
The in
predicate returns all records where a field is within a specified list:
>> User.ransack(age_in: 20..25).result.to_sql => SELECT "users".* FROM "users" WHERE "users"."age" IN (20, 21, 22, 23, 24, 25)
It can also take an array:
>> User.ransack(age_in: [20, 21, 22, 23, 24, 25]).result.to_sql => SELECT "users".* FROM "users" WHERE "users"."age" IN (20, 21, 22, 23, 24, 25)
Opposite: not_in
cont The cont
predicate returns all records where a field contains a given value:
>> User.ransack(first_name_cont: 'Rya').result.to_sql => SELECT "users".* FROM "users" WHERE ("users"."first_name" LIKE '%Rya%')
Opposite: not_cont
cont_any (contains any) The cont_any
predicate returns all records where a field contains any of the given values:
>> User.ransack(first_name_cont_any: %w(Rya Lis)).result.to_sql => SELECT "users".* FROM "users" WHERE (("users"."first_name" LIKE '%Rya%' OR "users"."first_name" LIKE '%Lis%'))
Opposite: not_cont_any
cont_all (contains all) The cont_all
predicate returns all records where a field contains all of the given values:
>> User.ransack(city_cont_all: %w(Grand Rapids)).result.to_sql => SELECT "users".* FROM "users" WHERE (("users"."city" LIKE '%Grand%' AND "users"."city" LIKE '%Rapids%'))
Opposite: not_cont_all
i_cont The i_cont
case-insensitive predicate returns all records where a field contains a given value and ignores case:
>> User.ransack(first_name_i_cont: 'Rya').result.to_sql => SELECT "users".* FROM "users" WHERE (LOWER("users"."first_name") LIKE '%rya%')
Opposite: not_i_cont
i_cont_any The i_cont_any
case-insensitive predicate returns all records where a field contains any of the given values and ignores case:
>> User.ransack(first_name_i_cont_any: %w(Rya Lis)).result.to_sql => SELECT "users".* FROM "users" WHERE ((LOWER("users"."first_name") LIKE '%rya%' OR LOWER("users"."first_name") LIKE '%lis%'))
Opposite: not_i_cont_any
i_cont_all The i_cont_all
case-insensitive predicate returns all records where a field contains all of the given values and ignores case:
>> User.ransack(city_i_cont_all: %w(Grand Rapids)).result.to_sql => SELECT "users".* FROM "users" WHERE ((LOWER("users"."city") LIKE '%grand%' AND LOWER("users"."city") LIKE '%rapids%'))
Opposite: not_i_cont_all
start (starts with) The start
predicate returns all records where a field begins with a given value:
>> User.ransack(first_name_start: 'Rya').result.to_sql => SELECT "users".* FROM "users" WHERE ("users"."first_name" LIKE 'Rya%')
Opposite: not_start
end (ends with) The end
predicate returns all records where a field ends with a given value:
>> User.ransack(first_name_end: 'yan').result.to_sql => SELECT "users".* FROM "users" WHERE ("users"."first_name" LIKE '%yan')
Opposite: not_end
true The true
predicate returns all records where a field is true. The '1' indicates that
+to Ransack that you indeed want to check the truthiness of this field. The other truthy
+values are 'true', 'TRUE', 't' or 'T'.
>> User.ransack(awesome_true: '1').result.to_sql => SELECT "users".* FROM "users" WHERE ("users"."awesome" = 't')
Note: different database systems use different values to represent truth. In the above
+example, we are using SQLite3.
Opposite: not_true
false The false
predicate returns all records where a field is false.
>> User.ransack(awesome_false: '1').result.to_sql => SELECT "users".* FROM "users" WHERE ("users"."awesome" = 'f')
Opposite: not_false
Note: the false
predicate may be considered the opposite of the true
predicate if the field does not contain null
values. Otherwise, use not_false
.
present The present
predicate returns all records where a field is present (not null and not a
+blank string).
>> User.ransack(first_name_present: '1').result.to_sql => SELECT "users".* FROM "users" WHERE (("users"."first_name" IS NOT NULL AND "users"."first_name" != ''))
Opposite: blank
null The null
predicate returns all records where a field is null:
>> User.ransack(first_name_null: 1).result.to_sql => SELECT "users".* FROM "users" WHERE "users"."first_name" IS NULL
Opposite: not_null
URL parameter structure The search parameters are passed to ransack as a hash. The URL representation of this hash uses the bracket notation: hash_name[key]=value
. The hash_name is the parameter which is defined in the controller, for instance q
. The key is the attribute and search predicate compound, for instance first_name_cont
, the value is the search parameter. When searching without using the search form helpers this URL structure needs to be created manually.
For example, the URL layout for searching and sorting users could looks like this:
/users.json?q[first_name_cont]=pete&q[last_name_cont]=jack&q[s]=created_at+desc
Note that the sorting parameter s
is nested within the q
hash.
When using JavaScript to create such a URL, a matching jQuery request could look like this:
$ . ajax ( { url : "/users.json" , data : { q : { first_name_cont : "pete" , last_name_cont : "jack" , s : "created_at desc" } } , success : function ( data ) { console . log ( data ) ; } } ) ;
+
+
+
+
\ No newline at end of file
diff --git a/going-further/associations.html b/going-further/associations.html
new file mode 100644
index 0000000..3e7c16a
--- /dev/null
+++ b/going-further/associations.html
@@ -0,0 +1,21 @@
+
+
+
+
+
+
+
+Associations | Ransack documentation
+
+
+
+
+
+
🏠 Going further Associations On this page
Associations You can easily use Ransack to search for objects in has_many
and belongs_to
+associations.
Given these associations...
class Employee < ActiveRecord::Base belongs_to :supervisor # has attributes first_name:string and last_name:string end class Department < ActiveRecord::Base has_many :supervisors # has attribute title:string end class Supervisor < ActiveRecord::Base belongs_to :department has_many :employees # has attribute last_name:string end
... and a controller...
class SupervisorsController < ApplicationController def index @q = Supervisor.ransack(params[:q]) @supervisors = @q.result.includes(:department, :employees) end end
... you might set up your form like this...
<%= search_form_for @q do |f| %> <%= f.label :last_name_cont %> <%= f.search_field :last_name_cont %> <%= f.label :department_title_cont %> <%= f.search_field :department_title_cont %> <%= f.label :employees_first_name_or_employees_last_name_cont %> <%= f.search_field :employees_first_name_or_employees_last_name_cont %> <%= f.submit "search" %> <% end %> ... <%= content_tag :table do %> <%= content_tag :th, sort_link(@q, :last_name) %> <%= content_tag :th, sort_link(@q, :department_title) %> <%= content_tag :th, sort_link(@q, :employees_last_name) %> <% end %>
If you have trouble sorting on associations, try using an SQL string with the
+pluralized table ('departments.title'
,'employees.last_name'
) instead of the
+symbolized association (:department_title)
, :employees_last_name
).
+
+
+
+
\ No newline at end of file
diff --git a/going-further/custom-predicates.html b/going-further/custom-predicates.html
new file mode 100644
index 0000000..b4ae6f3
--- /dev/null
+++ b/going-further/custom-predicates.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Custom predicates | Ransack documentation
+
+
+
+
+
+
🏠 Going further Custom predicates If you'd like to add your own custom Ransack predicates:
# config/initializers/ransack.rb Ransack.configure do |config| config.add_predicate 'equals_diddly', # Name your predicate # What non-compound ARel predicate will it use? (eq, matches, etc) arel_predicate: 'eq', # Format incoming values as you see fit. (Default: Don't do formatting) formatter: proc { |v| "#{v}-diddly" }, # Validate a value. An "invalid" value won't be used in a search. # Below is default. validator: proc { |v| v.present? }, # Should compounds be created? Will use the compound (any/all) version # of the arel_predicate to create a corresponding any/all version of # your predicate. (Default: true) compounds: true, # Force a specific column type for type-casting of supplied values. # (Default: use type from DB column) type: :string, # Use LOWER(column on database). # (Default: false) case_insensitive: true end
You can check all Arel predicates here .
If Arel does not have the predicate you are looking for, consider monkey patching it:
# config/initializers/ransack.rb module Arel module Predications def gteq_or_null(other) left = gteq(other) right = eq(nil) left.or(right) end end end Ransack.configure do |config| config.add_predicate 'gteq_or_null', arel_predicate: 'gteq_or_null' end
+
+
+
+
\ No newline at end of file
diff --git a/going-further/documentation.html b/going-further/documentation.html
new file mode 100644
index 0000000..4eefab5
--- /dev/null
+++ b/going-further/documentation.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Documentation | Ransack documentation
+
+
+
+
+
+
🏠 Going further Documentation On this page
Ransack uses Docusaurus for documentation. To contribute to the docs simply use the "Edit this page" link from any page to directly edit, or else pull the repo and edit locally.
Running locally Make sure you have npm
installed, then:
cd docs-website npm run start
Build Build the assets before commiting changes.
cd docs-website npm run build
Test locally cd docs-website npm run serve
+
+
+
+
\ No newline at end of file
diff --git a/going-further/exporting-to-csv.html b/going-further/exporting-to-csv.html
new file mode 100644
index 0000000..8c0678d
--- /dev/null
+++ b/going-further/exporting-to-csv.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+CSV Export | Ransack documentation
+
+
+
+
+
+
Exporting to CSV
Example downloading a csv file preserving ransack search, based on this gist
index.html.erb
< h1 > Users </ h1 > < %= search_form_for @q , url : dashboard_index_path do | f | % > < %= f . label : name_cont % > < %= f . search_field : name_cont % > < %= f . submit % > < % end % > < ul > <% @users.each do |user| %> < li > <%= user.name %> [<%= user.devices.map { | device | device . name } .join(', ') %>] </ li > <% end %> </ ul > < % if params [ : q ] % > < %= link_to 'Export 1' , dashboard_index_path ( { name : params [ : q ] [ : name_cont ] } . merge ( { format : : csv } ) ) % > < % else % > < %= link_to 'Export 2' , dashboard_index_path ( format : 'csv' ) % > < % end % >
user.rb
require 'csv' class User < ApplicationRecord has_many : devices def self . get_csv ( users ) CSV . generate do | csv | csv << [ "Name" , "Devices" ] users . each do | user | csv << [ user . name , user . devices . map { | device | device . name } . join ( ', ' ) ] end end end end
+
+
+
+
\ No newline at end of file
diff --git a/going-further/external-guides.html b/going-further/external-guides.html
new file mode 100644
index 0000000..c8f6186
--- /dev/null
+++ b/going-further/external-guides.html
@@ -0,0 +1,19 @@
+
+
+
+
+
+
+
+External resources | Ransack documentation
+
+
+
+
+
+
🏠 Going further External resources On this page
There is a plethora of material on Ransack around the internet. We've collected some here for your convenience.
Do you want to have a blog post or other content on Ransack highlighted? Please just edit the page, add your content and a Pull Request will be sent to Ransack maintainers for approval.
Screencasts Gems ActiveAdmin The Administration Framework for Rails uses Ransack internally Ransack Memory Automatically save and load Ransack's filtered params into the Rail's sessionMobility Ransack Search attributes translated by Mobility with Ransack.Ransack UI Framework for building a search UI with Ransack seems abandoned Blogs In French In Vietnamese
+
+
+
+
\ No newline at end of file
diff --git a/going-further/form-customisation.html b/going-further/form-customisation.html
new file mode 100644
index 0000000..c799d09
--- /dev/null
+++ b/going-further/form-customisation.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Form customisation | Ransack documentation
+
+
+
+
+
+
🏠 Going further Form customisation Predicate and attribute labels in forms may be specified with I18n in a translation file (see the locale files in Ransack::Locale for more examples):
en : ransack : asc : ascending desc : descending predicates : cont : contains not_cont : not contains start : starts with end : ends with gt : greater than lt : less than attributes : person : name : Full Name article : title : Article Title body : Main Content
The names of attribute fields may also be changed globally or under activerecord:
en : attributes : model_name : model_field1 : field name1 model_field2 : field name2 activerecord : attributes : namespace/article : title : AR Namespaced Title namespace_article : title : Old Ransack Namespaced Title
To limit the predicates in the predicate_select
form helper in a view template, pass an array of permitted predicates with only
:
<%= f.predicate_select only: %i(cont not_cont eq not_eq blank null) %>
Compound predicates (_any
& _all
) may be removed by passing the option compounds: false
.
<%= f.predicate_select compounds: false %>
Searchable attributes versus non-searchable ones may be specified as follows:
def self.ransackable_attributes(auth_object = nil) %w(searchable_attribute_1 searchable_attribute_2 ...) + _ransackers.keys end
+
+
+
+
\ No newline at end of file
diff --git a/going-further/i18n.html b/going-further/i18n.html
new file mode 100644
index 0000000..c601be8
--- /dev/null
+++ b/going-further/i18n.html
@@ -0,0 +1,22 @@
+
+
+
+
+
+
+
+i18n | Ransack documentation
+
+
+
+
+
+
i18n and Ransack Ransack translation files are available in
+Ransack::Locale . You may also be interested in one of the
+many translations for Ransack available at
+http://www.localeapp.com/projects/2999 .
Predicate and attribute translations in forms may be specified as follows (see
+the translation files in Ransack::Locale for more examples):
locales/en.yml:
en : ransack : asc : ascending desc : descending predicates : cont : contains not_cont : not contains start : starts with end : ends with gt : greater than lt : less than models : person : Passanger attributes : person : name : Full Name article : title : Article Title body : Main Content
Attribute names may also be changed globally, or under activerecord
:
en : attributes : model_name : model_field1 : field name1 model_field2 : field name2 activerecord : attributes : namespace/article : title : AR Namespaced Title namespace_article : title : Old Ransack Namespaced Title
+
+
+
+
\ No newline at end of file
diff --git a/going-further/merging-searches.html b/going-further/merging-searches.html
new file mode 100644
index 0000000..76b7fd8
--- /dev/null
+++ b/going-further/merging-searches.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Merging searches | Ransack documentation
+
+
+
+
+
+
🏠 Going further Merging searches To find records that match multiple searches, it's possible to merge all the ransack search conditions into an ActiveRecord relation to perform a single query. In order to avoid conflicts between joined table names it's necessary to set up a shared context to track table aliases used across all the conditions before initializing the searches:
shared_context = Ransack::Context.for(Person) search_parents = Person.ransack( { parent_name_eq: "A" }, context: shared_context ) search_children = Person.ransack( { children_name_eq: "B" }, context: shared_context ) shared_conditions = [search_parents, search_children].map { |search| Ransack::Visitor.new.accept(search.base) } Person.joins(shared_context.join_sources) .where(shared_conditions.reduce(&:or)) .to_sql
Produces:
SELECT "people" . * FROM "people" LEFT OUTER JOIN "people" "parents_people" ON "parents_people" . "id" = "people" . "parent_id" LEFT OUTER JOIN "people" "children_people" ON "children_people" . "parent_id" = "people" . "id" WHERE ( ( "parents_people" . "name" = 'A' OR "children_people" . "name" = 'B' ) ) ORDER BY "people" . "id" DESC
Admittedly this is not as simple as it should be, but it's workable for now. (Implementing #417 could make this more straightforward.)
+
+
+
+
\ No newline at end of file
diff --git a/going-further/other-notes.html b/going-further/other-notes.html
new file mode 100644
index 0000000..c9e9a1c
--- /dev/null
+++ b/going-further/other-notes.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+Other notes | Ransack documentation
+
+
+
+
+
+
🏠 Going further Other notes On this page
Ransack Aliases You can customize the attribute names for your Ransack searches by using a
+ransack_alias
. This is particularly useful for long attribute names that are
+necessary when querying associations or multiple columns.
class Post < ActiveRecord::Base belongs_to :author # Abbreviate :author_first_name_or_author_last_name to :author ransack_alias :author, :author_first_name_or_author_last_name end
Now, rather than using :author_first_name_or_author_last_name_cont
in your
+form, you can simply use :author_cont
. This serves to produce more expressive
+query parameters in your URLs.
<%= search_form_for @q do |f| %> <%= f.label :author_cont %> <%= f.search_field :author_cont %> <% end %>
You can also use ransack_alias
for sorting.
class Post < ActiveRecord::Base belongs_to :author # Abbreviate :author_first_name to :author ransack_alias :author, :author_first_name end
Now, you can use :author
instead of :author_first_name
in a sort_link
.
<%= sort_link(@q, :author) %>
Note that using :author_first_name_or_author_last_name_cont
would produce an invalid sql query. In those cases, Ransack ignores the sorting clause.
Problem with DISTINCT selects If passed distinct: true
, result
will generate a SELECT DISTINCT
to
+avoid returning duplicate rows, even if conditions on a join would otherwise
+result in some. It generates the same SQL as calling uniq
on the relation.
Please note that for many databases, a sort on an associated table's columns
+may result in invalid SQL with distinct: true
-- in those cases, you
+will need to modify the result as needed to allow these queries to work.
For example, you could call joins and includes on the result which has the
+effect of adding those tables columns to the select statement, overcoming
+the issue, like so:
def index @q = Person.ransack(params[:q]) @people = @q.result(distinct: true) .includes(:articles) .joins(:articles) .page(params[:page]) end
If the above doesn't help, you can also use ActiveRecord's select
query
+to explicitly add the columns you need, which brute force's adding the
+columns you need that your SQL engine is complaining about, you need to
+make sure you give all of the columns you care about, for example:
def index @q = Person.ransack(params[:q]) @people = @q.result(distinct: true) .select('people.*, articles.name, articles.description') .page(params[:page]) end
Another method to approach this when using Postgresql is to use ActiveRecords's .includes
in combination with .group
instead of distinct: true
.
For example:
def index @q = Person.ransack(params[:q]) @people = @q.result .group('persons.id') .includes(:articles) .page(params[:page]) end
A final way of last resort is to call to_a.uniq
on the collection at the end
+with the caveat that the de-duping is taking place in Ruby instead of in SQL,
+which is potentially slower and uses more memory, and that it may display
+awkwardly with pagination if the number of results is greater than the page size.
For example:
def index @q = Person.ransack(params[:q]) @people = @q.result.includes(:articles).page(params[:page]).to_a.uniq end
PG::UndefinedFunction: ERROR: could not identify an equality operator for type json
If you get the above error while using distinct: true
that means that
+one of the columns that Ransack is selecting is a json
column.
+PostgreSQL does not provide comparison operators for the json
type. While
+it is possible to work around this, in practice it's much better to convert those
+to jsonb
, as recommended by the PostgreSQL documentation .
Authorization (allowlisting/denylisting) By default, searching and sorting are authorized on any column of your model
+and no class methods/scopes are whitelisted.
Ransack adds four methods to ActiveRecord::Base
that you can redefine as
+class methods in your models to apply selective authorization:
ransackable_attributes
ransackable_associations
ransackable_scopes
ransortable_attributes
Here is how these four methods are implemented in Ransack:
# `ransackable_attributes` by default returns all column names # and any defined ransackers as an array of strings. # For overriding with a whitelist array of strings. # def ransackable_attributes(auth_object = nil) column_names + _ransackers.keys end # `ransackable_associations` by default returns the names # of all associations as an array of strings. # For overriding with a whitelist array of strings. # def ransackable_associations(auth_object = nil) reflect_on_all_associations.map { |a| a.name.to_s } end # `ransortable_attributes` by default returns the names # of all attributes available for sorting as an array of strings. # For overriding with a whitelist array of strings. # def ransortable_attributes(auth_object = nil) ransackable_attributes(auth_object) end # `ransackable_scopes` by default returns an empty array # i.e. no class methods/scopes are authorized. # For overriding with a whitelist array of *symbols*. # def ransackable_scopes(auth_object = nil) [] end
Any values not returned from these methods will be ignored by Ransack, i.e.
+they are not authorized.
All four methods can receive a single optional parameter, auth_object
. When
+you call the search or ransack method on your model, you can provide a value
+for an auth_object
key in the options hash which can be used by your own
+overridden methods.
Here is an example that puts all this together, adapted from
+this blog post by Ernie Miller .
+In an Article
model, add the following ransackable_attributes
class method
+(preferably private):
class Article < ActiveRecord::Base def self.ransackable_attributes(auth_object = nil) if auth_object == :admin # whitelist all attributes for admin super else # whitelist only the title and body attributes for other users super & %w(title body) end end private_class_method :ransackable_attributes end
Here is example code for the articles_controller
:
class ArticlesController < ApplicationController def index @q = Article.ransack(params[:q], auth_object: set_ransack_auth_object) @articles = @q.result end private def set_ransack_auth_object current_user.admin? ? :admin : nil end end
Trying it out in rails console
:
> Article => Article(id: integer, person_id: integer, title: string, body: text) > Article.ransackable_attributes => ["title", "body"] > Article.ransackable_attributes(:admin) => ["id", "person_id", "title", "body"] > Article.ransack(id_eq: 1).result.to_sql => SELECT "articles".* FROM "articles" # Note that search param was ignored! > Article.ransack({ id_eq: 1 }, { auth_object: nil }).result.to_sql => SELECT "articles".* FROM "articles" # Search param still ignored! > Article.ransack({ id_eq: 1 }, { auth_object: :admin }).result.to_sql => SELECT "articles".* FROM "articles" WHERE "articles"."id" = 1
That's it! Now you know how to whitelist/blacklist various elements in Ransack.
Handling unknown predicates or attributes By default, Ransack will ignore any unknown predicates or attributes:
Article.ransack(unknown_attr_eq: 'Ernie').result.to_sql => SELECT "articles".* FROM "articles"
Ransack may be configured to raise an error if passed an unknown predicate or
+attributes, by setting the ignore_unknown_conditions
option to false
in your
+Ransack initializer file at config/initializers/ransack.rb
:
Ransack.configure do |c| # Raise errors if a query contains an unknown predicate or attribute. # Default is true (do not raise error on unknown conditions). c.ignore_unknown_conditions = false end
Article.ransack(unknown_attr_eq: 'Ernie') # ArgumentError (Invalid search term unknown_attr_eq)
As an alternative to setting a global configuration option, the .ransack!
+class method also raises an error if passed an unknown condition:
Article.ransack!(unknown_attr_eq: 'Ernie') # ArgumentError: Invalid search term unknown_attr_eq
This is equivalent to the ignore_unknown_conditions
configuration option,
+except it may be applied on a case-by-case basis.
Using Scopes/Class Methods Continuing on from the preceding section, searching by scopes requires defining
+a whitelist of ransackable_scopes
on the model class. The whitelist should be
+an array of symbols . By default, all class methods (e.g. scopes) are ignored.
+Scopes will be applied for matching true
values, or for given values if the
+scope accepts a value:
class Employee < ActiveRecord::Base scope :activated, ->(boolean = true) { where(active: boolean) } scope :salary_gt, ->(amount) { where('salary > ?', amount) } # Scopes are just syntactical sugar for class methods, which may also be used: def self.hired_since(date) where('start_date >= ?', date) end def self.ransackable_scopes(auth_object = nil) if auth_object.try(:admin?) # allow admin users access to all three methods %i(activated hired_since salary_gt) else # allow other users to search on `activated` and `hired_since` only %i(activated hired_since) end end end Employee.ransack({ activated: true, hired_since: '2013-01-01' }) Employee.ransack({ salary_gt: 100_000 }, { auth_object: current_user })
In Rails 3 and 4, if the true
value is being passed via url params or some
+other mechanism that will convert it to a string, the true value may not be
+passed to the ransackable scope unless you wrap it in an array
+(i.e. activated: ['true']
). Ransack will take care of changing 'true' into a
+boolean. This is currently resolved in Rails 5 😃
However, perhaps you have user_id: [1]
and you do not want Ransack to convert
+1 into a boolean. (Values sanitized to booleans can be found in the
+constants.rb ).
+To turn this off globally, and handle type conversions yourself, set
+sanitize_custom_scope_booleans
to false in an initializer file like
+config/initializers/ransack.rb:
Ransack.configure do |c| c.sanitize_custom_scope_booleans = false end
To turn this off on a per-scope basis Ransack adds the following method to
+ActiveRecord::Base
that you can redefine to selectively override sanitization:
ransackable_scopes_skip_sanitize_args
Add the scope you wish to bypass this behavior to ransackable_scopes_skip_sanitize_args:
def self.ransackable_scopes_skip_sanitize_args [:scope_to_skip_sanitize_args] end
Scopes are a recent addition to Ransack and currently have a few caveats:
+First, a scope involving child associations needs to be defined in the parent
+table model, not in the child model. Second, scopes with an array as an
+argument are not easily usable yet, because the array currently needs to be
+wrapped in an array to function (see
+this issue ),
+which is not compatible with Ransack form helpers. For this use case, it may be
+better for now to use ransackers instead,
+where feasible. Pull requests with solutions and tests are welcome!
Grouping queries by OR instead of AND The default AND
grouping can be changed to OR
by adding m: 'or'
to the
+query hash.
You can easily try it in your controller code by changing params[:q]
in the
+index
action to params[:q].try(:merge, m: 'or')
as follows:
def index @q = Artist.ransack(params[:q].try(:merge, m: 'or')) @artists = @q.result end
Normally, if you wanted users to be able to toggle between AND
and OR
+query grouping, you would probably set up your search form so that m
was in
+the URL params hash, but here we assigned m
manually just to try it out
+quickly.
Alternatively, trying it in the Rails console:
artists = Artist.ransack(name_cont: 'foo', style_cont: 'bar', m: 'or') => Ransack::Search<class: Artist, base: Grouping <conditions: [ Condition <attributes: ["name"], predicate: cont, values: ["foo"]>, Condition <attributes: ["style"], predicate: cont, values: ["bar"]> ], combinator: or>> artists.result.to_sql => "SELECT \"artists\".* FROM \"artists\" WHERE ((\"artists\".\"name\" ILIKE '%foo%' OR \"artists\".\"style\" ILIKE '%bar%'))"
The combinator becomes or
instead of the default and
, and the SQL query
+becomes WHERE...OR
instead of WHERE...AND
.
This works with associations as well. Imagine an Artist model that has many
+Memberships, and many Musicians through Memberships:
artists = Artist.ransack(name_cont: 'foo', musicians_email_cont: 'bar', m: 'or') => Ransack::Search<class: Artist, base: Grouping <conditions: [ Condition <attributes: ["name"], predicate: cont, values: ["foo"]>, Condition <attributes: ["musicians_email"], predicate: cont, values: ["bar"]> ], combinator: or>> artists.result.to_sql => "SELECT \"artists\".* FROM \"artists\" LEFT OUTER JOIN \"memberships\" ON \"memberships\".\"artist_id\" = \"artists\".\"id\" LEFT OUTER JOIN \"musicians\" ON \"musicians\".\"id\" = \"memberships\".\"musician_id\" WHERE ((\"artists\".\"name\" ILIKE '%foo%' OR \"musicians\".\"email\" ILIKE '%bar%'))"
If you would like to combine the Ransack and SimpleForm form builders, set the
+RANSACK_FORM_BUILDER
environment variable before Rails boots up, e.g. in
+config/application.rb
before require 'rails/all'
as shown below (and add
+gem 'simple_form'
in your Gemfile).
require File.expand_path('../boot', __FILE__) ENV['RANSACK_FORM_BUILDER'] = '::SimpleForm::FormBuilder' require 'rails/all'
+
+
+
+
\ No newline at end of file
diff --git a/going-further/ransackers.html b/going-further/ransackers.html
new file mode 100644
index 0000000..e852f02
--- /dev/null
+++ b/going-further/ransackers.html
@@ -0,0 +1,23 @@
+
+
+
+
+
+
+
+Ransackers | Ransack documentation
+
+
+
+
+
+
On this page
Add custom search functions The main premise behind Ransack is to provide access to Arel predicate methods . Ransack provides special methods, called ransackers , for creating additional search functions via Arel.
A ransacker
method can return any Arel node that allows the usual predicate methods . Custom ransacker
s are an expert feature, and require a thorough understanding of Arel.
Arel Here are some resources for more information about Arel:
Ransacker methods enable search customization and are placed in the model. Arguments may be passed to a ransacker method via ransacker_args
(see Example #6 below).
Ransackers, like scopes, are not a cure-all. Many use cases can be better solved with a standard Ransack search on a dedicated database search field, which is faster, index-able, and scales better than converting/ransacking data on the fly.
Example Ransackers Search on field Search on the name
field reversed:
# in the model: ransacker :reversed_name, formatter: proc { |v| v.reverse } do |parent| parent.table[:name] end
Search using Datetime Convert a user string
input and a database datetime
field to the same date
format to find all records with a datetime
field (created_at
in this example) equal to that date :
# in the model: ransacker :created_at do Arel.sql('date(created_at)') end
in the view: <%= f.search_field( :created_at_date_equals, placeholder: t(:date_format) ) %> ... <%= sort_link(@search, :created_at, default_order: :desc) %>
# config/initializers/ransack.rb Ransack.configure do |config| config.add_predicate 'date_equals', arel_predicate: 'eq', formatter: proc { |v| v.to_date }, validator: proc { |v| v.present? }, type: :string end
2.1 It seems to be enough to change the model only, but don't forget to define the type that will returned as well.
# in the model: ransacker :created_at, type: :date do Arel.sql('date(created_at)') end
2.2. Postgresql with time zones If you're using different time zones for Rails and Postgresql you should expect to have some problems using the above solution.
+Example:
Rails at GMT -03:00 Postgresql at GMT -00:00 (UTC) A timestamp like 2019-07-18 01:21:29.826484
will be truncated to 2019-07-18
.
+But for your Rails application 2019-07-18 01:21:29.826484
is 2019-07-17 22:21:29.826484
at your time zone (GMT -03:00). So it should be truncated to 2019-07-17
instead.
So, you should convert the timestamp to your current Rails time zone before extracting the date.
# in the model: ransacker :created_at, type: :date do Arel.sql("date(created_at at time zone 'UTC' at time zone '#{Time.zone.name}')") end
Note that Time.zone.name
should return a time zone string suitable for Postgresql.
Postgres columns Search on a fixed key in a jsonb / hstore column:
In this example, we are searching a table with a column called properties
for records containing a key called link_type
.
For anything up to and including Rails 4.1, add this to your model
ransacker :link_type do |parent| Arel::Nodes::InfixOperation.new('->>', parent.table[:properties], 'link_type') end
When using Rails 4.2+ (Arel 6.0+), wrap the value in a build_quoted
call
ransacker :link_type do |parent| Arel::Nodes::InfixOperation.new('->>', parent.table[:properties], Arel::Nodes.build_quoted('link_type')) end
In the view, with a search on link_type_eq
using a collection select (for example with options like 'twitter', 'facebook', etc.), if the user selects 'twitter', Ransack will run a query like:
SELECT * FROM "foos" WHERE "foos"."properties" ->> 'link_type' = 'twitter';
To use the JSONB contains operator @> see here: [[PostgreSQL JSONB searches]].
Type conversions Convert an integer
database field to a string
in order to be able to use a cont
predicate (instead of the usual eq
which works out of the box with integers) to find all records where an integer field (id
in this example) contains an input string:
Simple version, using PostgreSQL:
# in the model: ransacker :id do Arel.sql("to_char(id, '9999999')") end
and the same, using MySQL:
ransacker :id do Arel.sql("CONVERT(#{table_name}.id, CHAR(8))") end
A more complete version (using PostgreSQL) that adds the table name to avoid ambiguity and strips spaces from the input:
ransacker :id do Arel.sql( "regexp_replace( to_char(\"#{table_name}\".\"id\", '9999999'), ' ', '', 'g')" ) end
In the view, for all 3 versions:
<%= f.search_field :id_cont, placeholder: 'Id' %> ... <%= sort_link(@search, :id) %>
Concatenated fields Search on a concatenated full name from first_name
and last_name
(several examples):
# in the model: ransacker :full_name do |parent| Arel::Nodes::InfixOperation.new('||', parent.table[:first_name], parent.table[:last_name]) end # or, to insert a space between `first_name` and `last_name`: ransacker :full_name do |parent| Arel::Nodes::InfixOperation.new('||', Arel::Nodes::InfixOperation.new('||', parent.table[:first_name], ' ' ), parent.table[:last_name] ) end # Caveat: with Arel >= 6 the separator ' ' string in the # preceding example needs to be quoted as follows: ransacker :full_name do |parent| Arel::Nodes::InfixOperation.new('||', Arel::Nodes::InfixOperation.new('||', parent.table[:first_name], Arel::Nodes.build_quoted(' ') ), parent.table[:last_name] ) end # works also in mariadb ransacker :full_name do |parent| Arel::Nodes::NamedFunction.new('concat_ws', [Arel::Nodes::SqlLiteral.new("' '"), parent.table[:first_name], parent.table[:last_name]]) end # case insensitive lookup ransacker :full_name, formatter: proc { |v| v.mb_chars.downcase.to_s } do |parent| Arel::Nodes::NamedFunction.new('LOWER', [Arel::Nodes::NamedFunction.new('concat_ws', [Arel::Nodes::SqlLiteral.new("' '"), parent.table[:first_name], parent.table[:last_name]])]) end
Passing arguments Passing arguments to a ransacker:
+Arguments may be passed to a ransacker method via ransacker_args
:
class Person ransacker :author_max_title_of_article_where_body_length_between, args: [:parent, :ransacker_args] do |parent, args| min, max = args query = <<-SQL (SELECT MAX(articles.title) FROM articles WHERE articles.person_id = people.id AND CHAR_LENGTH(articles.body) BETWEEN #{min.to_i} AND #{max.to_i} GROUP BY articles.person_id ) SQL Arel.sql(query) end end # Usage Person.ransack( conditions: [{ attributes: { '0' => { name: 'author_max_title_of_article_where_body_length_between', ransacker_args: [10, 100] } }, predicate_name: 'cont', values: ['Ransackers can take arguments'] }] ) => SELECT "people".* FROM "people" WHERE ( (SELECT MAX(articles.title) FROM articles WHERE articles.person_id = people.id AND CHAR_LENGTH(articles.body) BETWEEN 10 AND 100 GROUP BY articles.person_id ) LIKE '%Ransackers can take arguments%') ORDER BY "people"."id" DESC
Dropdowns Adding the attribute values associated with a column name to a searchable attribute in a dropdown options (instead of a traditional column name coming from a table). This is useful if using an associated table which is acting as a join table between a parent table and domain table. This will cache the data as the selections:
# in the model: Model.pluck(:name).each do |ground| ransacker ground.to_sym do |parent| Arel::Nodes::InfixOperation.new('AND', Arel::Nodes::InfixOperation.new('=', parent.table[:gor_name], ground), parent.table[:status] ) end end # This will not include the column names in the dropdown def self.ransackable_attributes(auth_object = nil) %w() + _ransackers.keys end
Testing for existence Testing for the existence of a row in another table via a join:
# in the model: ransacker :price_exists do |parent| # SQL syntax for PostgreSQL -- others may differ # This returns boolean true or false Arel.sql("(select exists (select 1 from prices where prices.book_id = books.id))") end
In the view
%td= f.select :price_exists_true, [["Any", 2], ["No", 0], ["Yes", 1]]
Associations Performing a query on an association with a differing class name:
Say we have a model "SalesAccount", which represents a relationship between two users,
+one being designated as a "sales_rep". We want to query SalesAccounts by
+the name of the sales_rep:
# in the model: class SalesAccount < ActiveRecord::Base belongs_to :user belongs_to :sales_rep, class_name: :User # in the controller: # The line below would lead to errors thrown later if not for the # "joins(:sales_reps)". @q = SalesAccount.includes(:user).joins(:sales_rep).ransack(params[:q]) @sales_accounts = @q.result(distinct: true)
In the view:
<%= f.search_field :sales_rep_name_start %>
Search on translations Search for a translated value in a jsonb column:
Note: There is also a gem, Mobility Ransack , which allows you to search on translated attributes independent of their storage backend.
This will work with any jsonb
data type. In this case I have a column translated with Mobility called name
with the value {'en': "Hello", 'es': "Hola"}
.
ransacker :name do |parent| Arel::Nodes::InfixOperation.new('->>', parent.table[:name], Arel::Nodes.build_quoted(Mobility.locale)) end
If using Rails 4.1 or under, remove the build_quoted
call.
You can then search for name_eq
or name_cont
and it will do the proper SQL.
Please feel free to contribute further code examples!
+
+
+
+
\ No newline at end of file
diff --git a/going-further/release_process.html b/going-further/release_process.html
new file mode 100644
index 0000000..bb15042
--- /dev/null
+++ b/going-further/release_process.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Versions and Releases | Ransack documentation
+
+
+
+
+
+
🏠 Going further Versions and Releases On this page
Semantic Versioning Ransack attempts to follow semantic versioning in the format of x.y.z
, where:
x
stands for a major version (new features that are not backward-compatible).
y
stands for a minor version (new features that are backward-compatible).
z
stands for a patch (bug fixes).
In other words: Major.Minor.Patch
.
Release Process For the maintainers of Ransack.
To release a new version of Ransack and publish it to RubyGems, take the following steps:
Create a new release, marked Prerelease
. Update the versions file to the new release, commit and push to master
. Update the version.rb
file to the new release, commit and push to master
. From the terminal, run the following commands:
+
+
+
+
\ No newline at end of file
diff --git a/going-further/saving-queries.html b/going-further/saving-queries.html
new file mode 100644
index 0000000..6e16a58
--- /dev/null
+++ b/going-further/saving-queries.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Saving queries | Ransack documentation
+
+
+
+
+
+
🏠 Going further Saving queries On this page
Ransack Memory Gem The Ransack Memory gem accomplishes this.
Custom solution If you want a custom solution, you can build it yourself. My ransack AJAX searching doesn’t save your search parameters across transactions. In this post I’ll show you how to easily add this capability in a generic way.
In this example I added AJAX search ability to index pages.
def index @search = ComponentDefinition.search(search_params) # make name the default sort column @search.sorts = 'name' if @search.sorts.empty? @component_definitions = @search.result().page(params[:page]) end
I added methods(search_params, clear_search_index) in the ApplicationController to add a level of abstraction from the search gem I was using. Turns out this made things super easy, especially considering I won’t have to update my code generation tools for index pages.
class ApplicationController < ActionController::Base def search_params params[:q] end def clear_search_index if params[:search_cancel] params.delete(:search_cancel) if(!search_params.nil?) search_params.each do |key, param| search_params[key] = nil end end end end end
I decided to store the ransack search parameters, params[:q], in the session. To make the session parameter unique I used a key creed from the controllers name and “_search”.
class ApplicationController < ActionController::Base # CHECK THE SESSION FOR SEARCH PARAMETERS IS THEY AREN'T IN THE REQUEST def search_params if params[:q] == nil params[:q] = session[search_key] end if params[:q] session[search_key] = params[:q] end params[:q] end # DELETE SEARCH PARAMETERS FROM THE SESSION def clear_search_index if params[:search_cancel] params.delete(:search_cancel) if(!search_params.nil?) search_params.each do |key, param| search_params[key] = nil end end # REMOVE FROM SESSION session.delete(search_key) end end protected # GENERATE A GENERIC SESSION KEY BASED ON TEH CONTROLLER NAME def search_key "#{controller_name}_search".to_sym end end
Based on Saving queries
+
+
+
+
\ No newline at end of file
diff --git a/going-further/searching-postgres.html b/going-further/searching-postgres.html
new file mode 100644
index 0000000..3a341df
--- /dev/null
+++ b/going-further/searching-postgres.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Postgres searches | Ransack documentation
+
+
+
+
+
+
🏠 Going further Postgres searches On this page
Searching on Postgres-specific column types.
Postgres Array searches See this issue for details.
PostgreSQL JSONB searches Using a fixed key See here for searching on a fixed key in a JSONB column: https://github.com/activerecord-hackery/ransack/wiki/Using-Ransackers#3-search-on-a-fixed-key-in-a-jsonb--hstore-column
Using the JSONB contains operator To fully use the power of the JSONB column you may want to filter on any key though:
Install the ActiveRecordExtended gem to add the contains
arel predicate to your project. It let's you use the Postgres contains operator @> .
Add a custom predicate in the config/initializers/ransack.rb
file:
Ransack.configure do |config| config.add_predicate 'jcont', arel_predicate: 'contains', formatter: proc { |v| JSON.parse(v) } end
Now you can ransack the JSONB columns using the _jcont predicate. For example the Person model has a data
JSONB column, find entries where the column contains the {"group": "experts"} key-value pair:
Person.ransack(data_jcont: '{"group": "experts"}').result.to_sql SELECT "persons".* FROM "persons" WHERE "persons"."data" @> '"{\"group\": \"experts\"}"'
If you have a GIN index on that column, the database will quickly be able to find that result.
Treating the column as a string Warning: This method converts the column to a string and matches the given string to the result. This will be slow on large data_sets and does not make good use of the JSONB capabilities of Postgres, such as indexes.
class Contact < ApplicationRecord ransacker :within_json do |parent| Arel.sql("table.jsonb_data::text") end end Contact.all.ransack("within_json_cont" => "my")
Will generate
SELECT "contacts".* FROM "contacts" WHERE contacts.json_data ILIKE '%my%'
Note that this search treats the entire JSON as string, including parens, etc. i.e. you can search for e.g.: Contact.all.ransack("within_json_cont" => '{"key": "value"}')
+
+
+
+
\ No newline at end of file
diff --git a/img/docusaurus.png b/img/docusaurus.png
new file mode 100644
index 0000000..f458149
Binary files /dev/null and b/img/docusaurus.png differ
diff --git a/img/favicon.ico b/img/favicon.ico
new file mode 100644
index 0000000..c01d54b
Binary files /dev/null and b/img/favicon.ico differ
diff --git a/img/logo.svg b/img/logo.svg
new file mode 100644
index 0000000..9db6d0d
--- /dev/null
+++ b/img/logo.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/img/tutorial/docsVersionDropdown.png b/img/tutorial/docsVersionDropdown.png
new file mode 100644
index 0000000..ff1cbe6
Binary files /dev/null and b/img/tutorial/docsVersionDropdown.png differ
diff --git a/img/tutorial/localeDropdown.png b/img/tutorial/localeDropdown.png
new file mode 100644
index 0000000..d7163f9
Binary files /dev/null and b/img/tutorial/localeDropdown.png differ
diff --git a/img/undraw_docusaurus_mountain.svg b/img/undraw_docusaurus_mountain.svg
new file mode 100644
index 0000000..af961c4
--- /dev/null
+++ b/img/undraw_docusaurus_mountain.svg
@@ -0,0 +1,171 @@
+
+ Easy to Use
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/img/undraw_docusaurus_react.svg b/img/undraw_docusaurus_react.svg
new file mode 100644
index 0000000..94b5cf0
--- /dev/null
+++ b/img/undraw_docusaurus_react.svg
@@ -0,0 +1,170 @@
+
+ Powered by React
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/img/undraw_docusaurus_tree.svg b/img/undraw_docusaurus_tree.svg
new file mode 100644
index 0000000..d9161d3
--- /dev/null
+++ b/img/undraw_docusaurus_tree.svg
@@ -0,0 +1,40 @@
+
+ Focus on What Matters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..d66bda8
--- /dev/null
+++ b/index.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+ Ransack
+
+
+ If you are not redirected automatically, follow this
+ link .
+
+
diff --git a/logo/ransack-h.png b/logo/ransack-h.png
new file mode 100644
index 0000000..d0866d8
Binary files /dev/null and b/logo/ransack-h.png differ
diff --git a/logo/ransack-h.svg b/logo/ransack-h.svg
new file mode 100644
index 0000000..4c49aef
--- /dev/null
+++ b/logo/ransack-h.svg
@@ -0,0 +1,34 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/logo/ransack-v.png b/logo/ransack-v.png
new file mode 100644
index 0000000..a5b2026
Binary files /dev/null and b/logo/ransack-v.png differ
diff --git a/logo/ransack-v.svg b/logo/ransack-v.svg
new file mode 100644
index 0000000..9a64c43
--- /dev/null
+++ b/logo/ransack-v.svg
@@ -0,0 +1,34 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/logo/ransack.png b/logo/ransack.png
new file mode 100644
index 0000000..8318fa4
Binary files /dev/null and b/logo/ransack.png differ
diff --git a/logo/ransack.svg b/logo/ransack.svg
new file mode 100644
index 0000000..0d7393e
--- /dev/null
+++ b/logo/ransack.svg
@@ -0,0 +1,21 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/markdown-page.html b/markdown-page.html
new file mode 100644
index 0000000..5514446
--- /dev/null
+++ b/markdown-page.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+
+
+Markdown page example | Ransack documentation
+
+
+
+
+
+
Markdown page example You don't need React to write simple standalone pages.
+
+
+
+
\ No newline at end of file
diff --git a/sitemap.xml b/sitemap.xml
new file mode 100644
index 0000000..e85fda7
--- /dev/null
+++ b/sitemap.xml
@@ -0,0 +1 @@
+https://activerecord-hackery.github.io/ransack/blog weekly 0.5 https://activerecord-hackery.github.io/ransack/blog/archive weekly 0.5 https://activerecord-hackery.github.io/ransack/blog/ransack-3-0-0 weekly 0.5 https://activerecord-hackery.github.io/ransack/blog/tags weekly 0.5 https://activerecord-hackery.github.io/ransack/blog/tags/ransack weekly 0.5 https://activerecord-hackery.github.io/ransack/blog/tags/release weekly 0.5 https://activerecord-hackery.github.io/ransack/markdown-page weekly 0.5 https://activerecord-hackery.github.io/ransack/ weekly 0.5 https://activerecord-hackery.github.io/ransack/getting-started/advanced-mode weekly 0.5 https://activerecord-hackery.github.io/ransack/getting-started/configuration weekly 0.5 https://activerecord-hackery.github.io/ransack/getting-started/search-matches weekly 0.5 https://activerecord-hackery.github.io/ransack/getting-started/simple-mode weekly 0.5 https://activerecord-hackery.github.io/ransack/getting-started/sorting weekly 0.5 https://activerecord-hackery.github.io/ransack/getting-started/using-predicates weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/associations weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/custom-predicates weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/documentation weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/exporting-to-csv weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/external-guides weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/form-customisation weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/i18n weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/merging-searches weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/other-notes weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/ransackers weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/release_process weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/saving-queries weekly 0.5 https://activerecord-hackery.github.io/ransack/going-further/searching-postgres weekly 0.5
\ No newline at end of file