Skip to content

Consists of control components for navigation and action. All are pre-styles and with the exception of <Navigation <properties-that-apply> /> and use bootstrap-css behind it.

Notifications You must be signed in to change notification settings

fatGNU/controls

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 

Repository files navigation

The <Navigation /> Component

This component is responsible for allowing a user to navigate between different components on a page. It has foward and the back navigations which render different components following an onClick callback method.

properties:

NOTE: The <other-props-list> in <Navigation <other-props-list> backwards /> and
    <Navigation <other-props-list> forwards /> is used for ILLUSTRATION ONLY.
    Do not use this notation in calling the Navigation component!
    Instead, replace that notation with at least one property and its value (if it applies).

NOTE 2: If either of forwards or backwards properties are missing at the same time,
    the component results to showing both the forwards and backwards instances at the same time.

See list of properties illustrated below:

    zIndex - a integer telling the component how shallow it should be in the DOM tree's z-axis view;
            that is, how far away it is from you.
            The higher the number the shallower it is. This mirrors and uses the
            CSS 'z-index' attribute. It defaults to 2050.
    
    position - an array of strings telling the component where in the viewport 
                it should position itself. In either <Navigation <other-props-list> backwards />
                or <Navigation <other-props-list> forwards />, it defaults to a top of 50% and 
                a left of 0% and 90% respectively.
                
    forwards - an attribute that tells the navigation component to show a forward navigation 
                component and mount it to the right of the viewport. Defaults to showing it
                at the center (along the viewport's height) -> top: 50%, left: 94% passed 
                in the position property as an array (by default) of ['50%','94%'].
                
    backwards - an attribute that tells the navigation component to show a backward navigation 
                componentand mount it to the left of the viewport. Defaults to showing it
                at the center (along the viewport's height)-> top: 50%, left: 0% passed 
                in the position property as an array (by default) of ['50%','0%'].
                
    navigableRoutes - this is an array of routes (complete with their (desired) properties)
                that the navigation switches in and out of the desired viewport area.
    
    callback - the method to call when the navigation is clicked. Note that the callback property
                assumes that it's concerned with switching of navigableComponents. The engineer
                should provide mechanisms of conducting additional functionality if desired.
                
    forwardColour - a string of HEX digits or colour name that tells the colour that is to be applied
                        to the forwards control.
  
    backwardColour - a string of HEX digits or colour nam that tells the colour that is to be applied to
                       the backwards control.
                       
    noBorder - a property that tells the navigation to not show a border around the shevron.
                 

The <SubmitButton /> and <CancelButton /> Components

These components each wrap the default HTMLButtonElement interface and provides two properties: callback and commandText.

callback - is a reference to an external method that should be executed when this control is clicked
commandText - is the text that is human-readable that tells what the button is intended for.

Note the case on the commandText property. These cases ARE CASE SENSITIVE.

About

Consists of control components for navigation and action. All are pre-styles and with the exception of <Navigation <properties-that-apply> /> and use bootstrap-css behind it.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published