react-singular-component

KO | EN

gitlite — search

#python #typescript #llm #golang #go #machine-learning #linux #docker #java #windows #kubernetes #awesome-list #ios #mcp

react-singular-component

(★ 15)

move your react component around the dom

react-singular-component Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# SingularComponent
Move your react component around the dom
### Click [Here](https://dor6.github.io/react-singular-component/) For Live Example!!!!!!!!

![alt text](https://image.ibb.co/jJ5Non/example.gif)

Transition from one component to another component seamlessly.
Use this for better user exprience, helping them understand its the same component.
Just wrap your components with the SingularComponent, give them the same singularKey, 
and a singularPriority to choose which one of them to show(higher priority will show the componenet).

## Install

npm install react-singular-component -S

## Usage

Here is a component (using semantic ui react) from the example project:

```jsx
import SingularComponent from 'react-singular-component';

class SingularSearch extends Component{

render(){
        const {singularPriority, style, value, onChange} = this.props;

return <SingularComponent singularKey="SingleInput" singularPriority={singularPriority}>
            <Input icon="search" value={value} style={style} onChange={onChange} />
        </SingularComponent>;
    }
}
```

I will render the SingularSearch component twice once with a singularPriority of 1 and once with a singularPriority of 2.
while i render both we will only see the instance with a priority of 2, but i will unmount the higher priority instance the component will move and change to the position and size of the lower priority instance.

## Props

<table class="table table-bordered table-striped">
    <thead>
    <tr>
        <th style="width: 100px;">name</th>
        <th style="width: 50px;">type</th>
        <th style="width: 50px;">default</th>
        <th style="width: 50px;">Required</th>
        <th>description</th>
    </tr>
    </thead>
    <tbody>
        <tr>
          <td>singularKey</td>
          <td>String</td>
          <td></td>
          <td>Required</td>
          <td>The library will make sure you always have only one SingularComponent with that key</td>
        </tr>
        <tr>
          <td>singularPriority</td>
          <td>Number</td>
          <td></td>
          <td>Required</td>
          <td>The library will keep only the one with the lower priority for every common singularKey</td>
        </tr>
        <tr>
          <td>children</td>
          <td>React element</td>
          <td></td>
          <td></td>
          <td>The element itself you want to keep single</td>
        </tr>
        <tr>
          <td>animationDuration</td>
          <td>Number</td>
          <td>500</td>
          <td></td>
          <td>Miliseconds duration</td>
        </tr>
        <tr>
          <td>animationTrigger</td>
          <td>Any</td>
          <td>0</td>
          <td></td>
          <td>Any input that when change will trigger an animation of the component, useful for cases when we want to animate the component when a state outside the scope of the component is changed. For example if a sibling component is moved and it will affect the component location, we can give the component as trigger its number of brothers. </td>
        </tr>
        <tr>
          <td>onAnimationBegin</td>
          <td>(originalElement, animationElement) => void</td>
          <td></td>
          <td></td>
          <td>callback when the animation begins</td>
        </tr>
        <tr>
          <td>onAnimationComplete</td>
          <td>(originalElement) => void</td>
          <td></td>
          <td></td>
          <td>Callback when the animation ends</td>
        </tr>
        <tr>
          <td>customTransitionElement</td>
          <td>React element</td>
          <td>The previous element will be taken</td>
          <td></td>
          <td>You can use it to replace the element that transitioned from one element to another</td>
        </tr>
        <tr>
          <td>easing</td>
          <td>'linear', 'easeInQuad', 'easeOutQuad', 'easeInOutQuad', 'easeInCubic', 'easeOutCubic', 'easeInOutCubic', 'easeInQuart', 'easeOutQuart', 'easeInOutQuart', 'easeInQuint', 'easeOutQuint', 'easeInOutQuint', 'easeInElastic', 'easeOutElastic', 'easeInOutElastic', 'easeInSin', 'easeOutSin', 'easeInOutSin'</td>
          <td>'easeOutQuad'</td>
          <td></td>
          <td>The name of the easing formula that will be used. See here: https://easings.net/ . </td>
        </tr>
         <tr>
          <td>useStyleAnimation</td>
          <td>Boolean</td>
          <td>false</td>
          <td></td>
          <td>when true animation will use width, height and fontSize to animate dimensions, instead of transform: scale. this can be useful in a lot of cases, for example when height and width ratio changes</td>
        </tr>
         <tr>
          <td>customAnimationHandlers</td>
          <td>['width','height','fontSize', 'color', 'backgroundColor', 'borderColor', 'borderRightColor', 'borderLeftColor', 'borderTopColor', 'borderBottomColor', 'borderWidth', 'borderRightWidth', 'borderLeftWidth', 'borderTopWidth', 'borderBottomWidth', 'padding', 'paddingLeft', 'paddingRight', 'paddingTop', 'paddingBottom', 'opacity', (element, valueFormula, startSnapshot, targetSnapshot, snapshotTrack) => void]</td>
          <td></td>
          <td></td>
          <td>choose your own animation (which will be added to the position animation), provide your array of changes in addition to existing style animation. provide an array of supported styles you want to animate, in addition to your own custom function to animate yet unimplemented styles or more advance animation.
    customAnimationHandler get as arguments:
              <br/>
              - element: the animated element to change.
              <br/>
              - valueFormula: (startValue(number), endValue(number)) => currentValue(number), use the targetSnapshot and endSnapshot to choose calculate the values of the styles you want to animate 
              <br/>
              - startSnapshot: contains rect(getBoundingClientRect) and style(getComputedStyle) of element before the animation started
              <br/>
              - targetSnapshot: same as startSnapshot but of the element end state of the animation
              <br/>
              - snapshotTrack: update this object with the styles you used and updated in the element. for example when using snapshot.style.width and we calculate new width, we will set snapshotTrack.style.width = element.style.width = calculated width. this is used for continousAnimation which enables animating from the middle of another animation without the element jumping from place to place.
              <br/>
              <br/>
              ~~~snapshots explained~~~
              <br/>
              startSnapshot belongs to the instance of the component we animating from and target snapshot belongs to the instace of the component we are animating to
            </td>
        </tr>
        <tr>
          <td>extraSnapshotStyleAttributes</td>
          <td>Array of style attributes in camelCase</td>
          <td>[]</td>
          <td></td>
          <td>Add the given style attributes to the style snapshot they will be joined with the customAnimtionHandlers provided by their name ('width', 'fontSize'...). use this when you make your own customAnimationHandler and the given snapshot isnt enough. ( copying all the styles to the snapshot is to heavy )</td>
        </tr>
        <tr>
          <td>continuousAnimation</td>
          <td>Boolean</td>
          <td>true</td>
          <td></td>
          <td>When true, if the component starts a new animation in the middle of an ongoing one, the component will animate from its current postion and not from its last position. making sure the animation will continue and the component won't jump when starting a new animation. (when reffering to position, this includes the whole snapshot). if you use your own animation handler and you dont update the snapshotTrack, you will want to set this prop to false</td>
        </tr>
    </tbody>
</table>

## Contribute

Simply fork and clone

npm install
    npm start

and you're ready to go and make whatever changes you have in mind

Please note this is only the start of the this project there is a lot to add.
This is a concept I want to push forward and needs work.

## Changelog

view the changelog  [here](https://github.com/dor6/react-singular-component/blob/master/CHANGELOG.md)

react-singular-component

react-singular-component Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

react-singular-component

react-singular-component Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README