<linkrel="alternate"type="application/atom+xml"href="/ransack/blog/atom.xml"title="Ransack documentation Atom Feed"><titledata-rh="true">Introduction | Ransack documentation</title><metadata-rh="true"name="twitter:card"content="summary_large_image"><metadata-rh="true"property="og:url"content="https://activerecord-hackery.github.io/ransack/"><metadata-rh="true"name="docusaurus_locale"content="en"><metadata-rh="true"name="docsearch:language"content="en"><metadata-rh="true"name="docusaurus_version"content="current"><metadata-rh="true"name="docusaurus_tag"content="docs-default-current"><metadata-rh="true"name="docsearch:version"content="current"><metadata-rh="true"name="docsearch:docusaurus_tag"content="docs-default-current"><metadata-rh="true"property="og:title"content="Introduction | Ransack documentation"><metadata-rh="true"name="description"content="Ransack will help you easily add searching to your Rails application, without any additional dependencies."><metadata-rh="true"property="og:description"content="Ransack will help you easily add searching to your Rails application, without any additional dependencies."><linkdata-rh="true"rel="icon"href="/ransack/img/favicon.ico"><linkdata-rh="true"rel="canonical"href="https://activerecord-hackery.github.io/ransack/"><linkdata-rh="true"rel="alternate"href="https://activerecord-hackery.github.io/ransack/"hreflang="en"><linkdata-rh="true"rel="alternate"href="https://activerecord-hackery.github.io/ransack/"hreflang="x-default"><scriptdata-rh="true">functionmaybeInsertBanner(){window.__DOCUSAURUS_INSERT_BASEURL_BANNER&&insertBanner()}functioninsertBanner(){varn=document.getElementById("docusaurus-base-url-issue-banner-container");if(n){n.innerHTML='\n<div id="docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseurl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/ransack/</span> </p>\n <p>We suggest trying baseUrl = <span id="docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n';vare=document.getElementById("docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,r="/"===s.substr(-1)?s:s+"/";e.innerHTML=r}}window.__DOCUSAURUS_INSERT_BASEURL_BANNER=!0,document.addEventListener("DOMContentLoaded",maybeInsertBanner)</script><linkrel="stylesheet"href="/ransack/assets/css/styles.1d70fab6.css">
<divid="docusaurus-base-url-issue-banner-container"></div><divrole="region"><ahref="#"class="skipToContent_fXgn">Skip to main content</a></div><navclass="navbar navbar--fixed-top"><divclass="navbar__inner"><divclass="navbar__items"><buttonaria-label="Navigation bar toggle"class="navbar__toggle clean-btn"type="button"tabindex="0"><svgwidth="30"height="30"viewBox="0 0 30 30"aria-hidden="true"><pathstroke="currentColor"stroke-linecap="round"stroke-miterlimit="10"stroke-width="2"d="M4 7h22M4 15h22M4 23h22"></path></svg></button><aclass="navbar__brand"href="/ransack/"><divclass="navbar__logo"><imgsrc="/ransack/./logo/ransack-h.png"alt="Ransack Logo"class="themedImage_ToTc themedImage--light_HNdA"><imgsrc="/ransack/./logo/ransack-h.png"alt="Ransack Logo"class="themedImage_ToTc themedImage--dark_i4oU"></div></a><aaria-current="page"class="navbar__item navbar__link navbar__link--active"href="/ransack/">Documentation</a><aclass="navbar__item navbar__link"href="/ransack/blog/">Blog</a></div><divclass="navbar__items navbar__items--right"><ahref="https://github.com/activerecord-hackery/ransack"target="_blank"rel="noopener noreferrer"class="navbar__item navbar__link">GitHub<svgwidth="13.5"height="13.5"aria-hidden="true"viewBox="0 0 24 24"class="iconExternalLink_lCJq"><pathfill="currentColor"d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><divclass="toggle_vylO colorModeToggle_DEke"><buttonclass="clean-btn toggleButton_gllP toggleButtonDisabled_aARS"type="button"disabled=""title="Switch between dark and light mode (currently light mode)"aria-label="Switch between dark and light mode (currently light mode)"><svgviewBox="0 0 24 24"width="24"height="24"class="lightToggleIcon_pyhR"><pathfill="currentColor"d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svgviewBox="0 0 24 24"width="24"height="24"class="darkToggleIcon_wfgR"><pathfill="currentColor"d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><divclass="searchBox_ZlJk"><divclass="navbar__search searchBarContainer_NW3z"><inputplaceholder="Search"aria-label="Search"class="navbar__search-input"><divclass="loadingRing_RJI3 searchBarLoadingRing_YnHq"><div></div><div></div><div></div><div></div></div><divclass="searchHintContainer_Pkmr"><kbdclass="searchHint_iIMx">ctrl</kbd><kbdclass="searchHint_iIMx">K</kbd></div></div></div></div></div><divrole="presentation"class="navbar-sidebar__backdrop"></div></nav><divclass="main-wrapper docsWrapper_BCFX"><buttonaria-label="Scroll back to top"class="clean-btn theme-back-to-top-button backToTopButton_sjWU"type="button"></button><divclass="docPage__5DB"><asideclass="theme-doc-sidebar-container docSidebarContainer_b6E3">
<ahref="http://ransack-demo.herokuapp.com/users/advanced_search"target="_blank"rel="noopener noreferrer">advanced</a> search forms for your Ruby on Rails application.</p><h2class="anchor anchorWithStickyNavbar_LWe7"id="issues-tracker">Issues tracker<aclass="hash-link"href="#issues-tracker"title="Direct link to heading"></a></h2><ul><li>Before filing an issue, please read the <ahref="https://github.com/activerecord-hackery/ransack/CONTRIBUTING.md"target="_blank"rel="noopener noreferrer">Contributing Guide</a>.</li><li>File an issue if a bug is caused by Ransack, is new (has not already been reported), and <em>can be reproduced from the information you provide</em>.</li><li>Please consider adding a branch with a failing spec describing the problem.</li><li>Contributions are welcome. 😃</li><li>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!</li></ul><h2class="anchor anchorWithStickyNavbar_LWe7"id="contributions">Contributions<aclass="hash-link"href="#contributions"title="Direct link to heading"></a></h2><p>To support the project:</p><ul><li>Consider supporting us via <ahref="https://opencollective.com/ransack/backers/badge.svg"target="_blank"rel="noopener noreferrer">Open Collective</a></li><li>Use Ransack in your apps, and let us know if you encounter anything that's
broken or missing. A failing spec to demonstrate the issue is awesome. A pull
request with passing tests is even better!</li><li>Before filing an issue or pull request, be sure to read and follow the
<ahref="https://github.com/activerecord-hackery/ransack/CONTRIBUTING.md"target="_blank"rel="noopener noreferrer">Contributing Guide</a>.</li><li>Please use Stack Overflow or other sites for questions or discussion not
directly related to bug reports, pull requests, or documentation improvements.</li><li>Spread the word on Twitter, Facebook, and elsewhere if Ransack's been useful
to you. The more people who are using the project, the quicker we can find and
fix bugs!</li></ul><h2class="anchor anchorWithStickyNavbar_LWe7"id="contributors">Contributors<aclass="hash-link"href="#contributors"title="Direct link to heading"></a></h2><p>Ransack was created by <ahref="http://twitter.com/erniemiller"target="_blank"rel="noopener noreferrer">Ernie Miller</a> and is developed and maintained by:</p><ul><li><ahref="https://github.com/scarroll32"target="_blank"rel="noopener noreferrer">Sean Carroll</a></li><li><ahref="https://github.com/deivid-rodriguez"target="_blank"rel="noopener noreferrer">Deivid Rodriguez</a></li><li><ahref="https://github.com/gregmolnar"target="_blank"rel="noopener noreferrer">Greg Molnar</a></li><li><ahref="https://github.com/activerecord-hackery/ransack/graphs/contributors"target="_blank"rel="noopener noreferrer">A great group of contributors</a>.</li></ul><ul><li>Ransack's logo is designed by <ahref="https://github.com/anilkilic"target="_blank"rel="noopener noreferrer">Anıl Kılıç</a>.</li></ul><p>Alumni Maintainers</p><ul><li><ahref="http://twitter.com/jonatack"target="_blank"rel="noopener noreferrer">Jon Atack</a></li><li><ahref="http://twitter.com/ryanbigg"target="_blank"rel="noopener noreferrer">Ryan Bigg</a></li></ul><p>This project exists thanks to all the people who contribute. <imgloading="lazy"src="https://opencollective.com/ransack/contributors.svg?width=890&button=false"class="img_ev3q"></p><h2class="anchor anchorWithStickyNavbar_LWe7"id="backers">Backers<aclass="hash-link"href="#backers"title="Direct link to heading"></a></h2><p>Thank you to all our backers! 🙏 [<ahref="https://opencollective.com/ransack#backer"target="_blank"rel="noopener noreferrer">Become a backer</a>]</p><ahref="https://opencollective.com/ransack#backers"target="_blank"rel="noopener noreferrer"><imgloading="lazy"src="https://opencollective.com/ransack/backers.svg?width=890"class="img_ev3q"></a><h2class="anchor anchorWithStickyNavbar_LWe7"id="sponsors">Sponsors<aclass="hash-link"href="#sponsors"title="Direct link to heading"></a></h2><p>Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [<ahref="https://opencollective.com/ransack#sponsor"target="_blank"rel="noopener noreferrer">Become a sponsor</a>]</p><ahref="https://opencollective.com/ransack/sponsor/0/website"target="_blank"rel="noopener noreferrer"><imgloading="lazy"src="https://opencollective.com/ransack/sponsor/0/avatar.svg"class="img_ev3q"></a><ahref="https://opencollective.com/ransack/sponsor/1/website"target="_blank"rel="noopener noreferrer"><imgloading="lazy"src="https://opencollective.com/ransack/sponsor/1/avatar.svg"class="img_ev3q"></a><ahref="https://opencollective.com/ransack/sponsor/2/website"target="_blank"rel="noopener noreferrer"><imgloading="lazy"src="https://opencollective.com/ransack/sponsor/2/avatar.svg"class="img_ev3q"></a><ahref="https://opencollective.com/ransack/sponsor/3/website"target="_blank"rel="noopener noreferrer"><imgloading="lazy"src="https://opencollective.com/ransack/sponsor/3/avatar.svg"class="img_ev3q"></a><ahref="https://opencollective.com/ransack/sponsor/4/website"target="_blank"rel="noopener noreferrer"><imgloading="lazy"src="https://opencollective.com/ransack/sponsor/4/avatar.svg"class="img_ev3q"></a><ahref="https://opencollective.com/ransack/sponsor/5/website"target="_blank"rel="noopener noreferrer"><imgloading="lazy"src="https://opencollective.com/ransack/sponsor/5/avatar.svg"class="img_ev3q"></a><ahref="https://opencollective.com/ransack/sponsor/6/website"target="_blank"rel="noopener noreferrer"><imgloading="lazy"src="https://opencollective.com/ransack/sponsor/6/avatar.svg"class="img_ev3q"></a><ahref="https://opencollective.com/ransack/sponsor/7/website"target="_blank"rel="noopener noreferrer"><imgloading="lazy"src="https://opencollective.com/ransack/sponsor/7/avatar.svg"class="img_ev3q"></a><ahref="https://opencollective.com/ransack/sponsor/8/website"target="_blank"rel="noopener noreferrer"><imgloading="lazy"
