Home Reference Source
import ReferenceExampleBox from 'myr/src/components/reference/RefExInfo.js'
public class | source

ReferenceExampleBox

Extends:

react~Component → ReferenceExampleBox

Reference Example Box is react component for displaying information about API in reference example scene

Member Summary

Public Members
public

renderParams(functionParams: array): string: *

Returns parentheses that includes parameters for the example

public

renderTitle: HTMLElement: *

Create header element with function name and parameters

public

suggestedCourse: Button: *

Check the redux state to see if example has suggested course and create elements according to it

Method Summary

Public Methods
public

render(): *

Render title and description of example scene

Public Members

public renderParams(functionParams: array): string: * source

Returns parentheses that includes parameters for the example

Return:

string

list of

public renderTitle: HTMLElement: * source

Create header element with function name and parameters

Return:

HTMLElement

h3 tag with "Function: name(parameters)"

public suggestedCourse: Button: * source

Check the redux state to see if example has suggested course and create elements according to it

Return:

Button

Button with name of suggested course on it

Public Methods

public render(): * source

Render title and description of example scene

Return:

*