Yeast engine API documentation

YST.Config namespace

YST.Config allows developers and designers to configure the way Yeast templates processor works.

YST.Config defines several configuration settings. Some of them are thought to be configured in the own yst.js source code file (e.g., YST.config.debug or YST.config.removeYSTAttributes). Other settings can be changed in the Yeast templates calling their setter methods shown below.

You can read more details about the Yeast engine configuration in the Template Tutorial.

 

Function summary
Back to top

YST.Config.setAlertErrors (show: boolean)

Activates / deactivates the messages that alert about template processing errors.

YST.Config.setHideBodyOnProcess (hide: boolean)

Hides (or shows) the template body whilst the Yeast engine is processing the template.

YST.Config.setShowProcessingBox (show: boolean)

At the beginning of the Yeast templates processing, the Yeast engine may show a red box in the upper right corner of the browser window indicating that the processing is in progress.

 

Function detail
Back to top

YST.Config.setAlertErrors (show: boolean)

Activates / deactivates the messages that alert about template processing errors.

If this setting is true the Yeast processor will show alerts (using the Javascript alert() function) with information about the error and where it is located. If the setting is false, and an error is found, this will be reported through the default browser error reporting mechanism.

parameter   type description
show boolean  

YST.Config.setHideBodyOnProcess (hide: boolean)

Hides (or shows) the template body whilst the Yeast engine is processing the template.

If the hide param is false, the template body will be shown, including the Yeast expression. The user will see this Yeast expressions, fact that may be considered annoying by some designers.

parameter   type description
hide boolean  

YST.Config.setShowProcessingBox (show: boolean)

At the beginning of the Yeast templates processing, the Yeast engine may show a red box in the upper right corner of the browser window indicating that the processing is in progress. This box will be removed once the template processing is finished.

The box shows the text "Processing ...".

This method activates / deactivates this facility.

parameter   type description
show boolean