nicoknoll / PageTableExtended

Extends the Processwire PageTable field for rendering table row layouts.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PageTableExtended

Extends the Processwire PageTable field for rendering table row layouts. This is great for editors, because they actually see at a glance what the table rows consist of.

What it does

Turns the Processwire Fieldtype "Page Table" from this:

PageTable before

into something like this:

PageTable after

See it in action

ProcessWire PageTableExtended Video

Requirements

  • FieldtypePageTable installed (part of the core since Processwire 2.4.10.)
  • Templates used for PageTable need a file associated (otherwise nothing gets rendered)
  • This render method is meant for sites where the PageTable templates only render part of the layout, not complete websites. But you also can define what will be rendered (see below).

Installation

  • Download and copy folder in your /sites/modules/ directory
  • In Admin, go to "modules" and "search for new modules"
  • Choose "PageTableExtended" and install
  • Create a new field with type "PageTableExtended"
  • Don't forget to define some templates for usage with PageTable(Extended)
  • It should be fine to change a already used PageTable field to the extended version. But remember to check the "keep settings and content" option.

Options

PageTableExtended settings

Render Layout instead of table rows

Check this for seeing the rows rendered. You can easily turn off the complete functionality by unchecking this.

Path to Templates

If you use a delegated template approach, please provide your path to the templates (relative to templates directory).

Collapse unpublished rows

If checked, unpublished PageTable parts are rendered collapsed and can be opened on click.

Path to Stylesheet

Since the parts are unstyled by default, it is a good idea to define styles for them. All rendered templates are encapsulated in a div with the class "renderedLayout" so you can style them with:

div.renderedLayout h2{
  color: green;
}

(hidden) Passed option to rendered layouts

An option "PageTableExtended" is passed to the rendered templates when rendered from this module. With that you can render customized code for your PageTableExtended template or just alter the current one. Like this:

if($options['pageTableExtended']){
	echo "this is rendered in admin: {$page->title}"; 	// we are in Admin section
} else {
	echo "this is the frontend: {$page->title}"; 		// we are in the frontend
}

The path is to be set relative to your templates' folder.

(hidden) CSS classes for PageTable page status

The rendered parts get the status of the page as CSS class:

  • "pte-hidden" for hidden pages
  • "pte-unpublished" for unpublished pages
  • "pte-locked" for locked pages

Reset Admin CSS

Since the parts are rendered inside the Admin, common styles of the Admin Interface apply also to your layout parts. This is not a bad thing, because especially text styles are well integrated in your admin's theme. But if you like to override the admin styles in your table rows completely (more or less), just check this box. Don't forget to define a custom CSS then!

Advanced

Since this module is meant for parts of your layout you already have defined for your frontend templates, it is a good idea to use a preprocessor like Stylus, Sass or Less for building the custom CSS file. Just outsource your layout part definitions in an extra file, compile that in a separete CSS file and use this as custom CSS for this module. Since your CSS should be built in a modular way, this works pretty well ;-) Will write a tutorial with a use case once finished testing.

About

Extends the Processwire PageTable field for rendering table row layouts.


Languages

Language:CSS 74.7%Language:JavaScript 25.3%