Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
135 lines (76 sloc) 3.25 KB

@gov.au/searchbox

Contents


Install

yarn add @gov.au/searchbox
npm install @gov.au/searchbox

⬆ back to top


Dependency graph

searchbox
β”œβ”€ core
β”œβ”€ text-inputs
β”‚  └─ core
└─ buttons
   └─ core

⬆ back to top


Tests

The visual test: https://auds.service.gov.au/packages/searchbox/tests/site/

⬆ back to top


Release History

  • v0.2.2 - Increase size for icon
  • v0.2.1 - Add styling for secondary buttons
  • v0.2.0 - Update padding on button, fix JSdoc
  • v0.1.0 - πŸ’₯ Initial version

⬆ back to top


License

Copyright (c) Commonwealth of Australia. Licensed under MIT.

⬆ back to top

};


Usage

⬆ back to top


React

Usage:

import AUsearchbox from '@gov.au/searchbox';

<AUsearchbox 
	label="Search" 
	btnText="Search"
	responsive={true}
	id="def-search"
	btnProps={{ onClick: () => console.log('hello'), className: 'blah', type: 'button' }}
/>

All props:


<AUsearchbox 
	label="Search"                        {/* Text of the label */}
	btnText="Search"                      {/* Text on the button */}
	dark={true}                           {/* Dark variation */}
	responsive={true}                     {/* Responsive variation, text turns to icon on smaller devices*/}
	icon={false}                       Β   {/* Icon only, hides text on button */}
	id="def-search"                       {/* ID of the text input, required */}
	className=""                          {/* Additional class, optional */}
	wrapper="form"                        {/* Wrapper component. Can be a div or form. */}
	btnProps= {{type: 'button'}}          {/* Additonal props to be spread into the button */}
	inputProps= {{type: 'text'}}          {/* Additonal props to be spread into the text input */}
/>
You can’t perform that action at this time.