A positioning engine to make overlays, tooltips and dropdowns better
npm install react-tether!CI Status

> Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs.
---
React wrapper around Tether, a positioning engine to make overlays, tooltips and dropdowns better
npm install react-tether
As of version 2, a minimum of React 16.3 is required. If you need support for React < 16.3 please use the 1.x branch.
``javascript
import TetherComponent from "react-tether";
class SimpleDemo extends React.Component {
constructor(props) {
super(props);
this.state = {
isOpen: false,
};
}
render() {
const { isOpen } = this.state;
return (
constraints={[
{
to: "scrollParent",
attachment: "together",
},
]}
/ renderTarget: This is what the item will be tethered to, make sure to attach the ref /
renderTarget={(ref) => (
ref={ref}
onClick={() => {
this.setState({ isOpen: !isOpen });
}}
>
Toggle Tethered Content
)}
/ renderElement: If present, this item will be tethered to the the component returned by renderTarget /
renderElement={(ref) =>
isOpen && (
A paragraph to accompany the title.
Props
####
renderTarget: PropTypes.funcThis is a render prop, the component returned from this function will be Tether's
target. One argument, ref, is passed into this function. This is a ref that must be attached to the highest possible DOM node in the tree. If this is not done the element will not render.####
renderElement: PropTypes.funcThis is a render prop, the component returned from this function will be Tether's
element, that will be moved. If no component is returned, the target will still render, but with no element tethered. One argument, ref, is passed into this function. This is a ref that must be attached to the highest possible DOM node in the tree. If this is not done the element will not render.####
renderElementTag: PropTypes.stringThe tag that is used to render the Tether element, defaults to
div.####
renderElementTo: PropTypes.stringWhere in the DOM the Tether element is appended. Passes in any valid selector to
document.querySelector. Defaults to document.body.Tether requires this element to be
position: static;, otherwise it will default to document.body. See this example for more information.####
Tether Options:Any valid Tether options.
####
children:Previous versions of react-tether used children to render the target and component, using children will now throw an error. Please use renderTarget and renderElement instead
Imperative API
The following methods are exposed on the component instance:
-
getTetherInstance(): Tether
- disable(): void
- enable(): void
- on(event: string, handler: function, ctx: any): void
- once(event: string, handler: function, ctx: any): void
- off(event: string, handler: function): void
- position(): void#### Example usage:
`javascript
ref={(tether) => (this.tether = tether)}
renderTarget={(ref) => }
renderElement={(ref) => (
this.tether && this.tether.position()} />
)}
/>
`Run Example
clone repo
git clone git@github.com:danreeves/react-tether.gitmove into folder
cd ~/react-tetherinstall dependencies
npm installrun dev mode
npm run demoopen your browser and visit:
http://localhost:1234/`