motiontactic/sage-flex

Extends Sage Acorn to add commands to scaffold flexible components quickly

Maintainers

Details

github.com/mt-gareth/sage-flex

Source

Issues

Installs: 133

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 1

Forks: 0

Open Issues: 0

1.2 2022-03-29 21:52 UTC

Requires

MIT a165b5f6d3fb351c29611304b5165e3bf544609f

  • Gareth McDonald <gareth.woop@motiontactic.com>

This package is auto-updated.

Last update: 2024-03-29 04:06:06 UTC

README

Latest Stable VersionTotal DownloadsLicense

Extends Sage Acorn to add commands to scaffold flexible components quickly

Install

In sage theme run

composer require motiontactic/sage-flex

To publish files that are used in most sites run:

wp acorn publish:mt

these files will be added or updated:

/app/View/Composers/Flex.php
/resources/assets/scripts/app.js
/resources/assets/styles/app.scss
/resources/assets/scripts/flex/index.js
/resources/assets/styles/flex/index.scss

/resources/assets/scripts/common/index.js
/resources/assets/scripts/common/responsive-bgs.js

/resources/assets/styles/common/fonts.scss
/resources/assets/styles/common/global.scss
/resources/assets/styles/common/grid.scss
/resources/assets/styles/common/index.scss
/resources/assets/styles/common/mixins.scss
/resources/assets/styles/common/spacing-modifiers.scss
/resources/assets/styles/common/variables.scss

/resources/views/partials/bg.blade.php
/resources/views/partials/content-page.blade.php

mu-plugins/site.php
mu-plugins/site/composer.json
mu-plugins/site/advanced-custom-fields-pro

Usage

Commands

Main Scaffolding Command

wp acorn make:flex ComponentName

Where ComponentName is the name of the new flexible component you would like made, should be in CamelCase.

wp acorn remove:flex ComponentName

Where ComponentName is the name of the old flexible component you would like removed, should be in CamelCase.

Other Commands

wp acorn make:flex-controller ComponentName
wp acorn make:flex-script ComponentName
wp acorn make:flex-style ComponentName
wp acorn make:flex-template ComponentName

wp acorn remove:flex-controller ComponentName
wp acorn remove:flex-script ComponentName
wp acorn remove:flex-style ComponentName
wp acorn remove:flex-template ComponentName

Each command makes or removes a single file.

wp acorn publish:flex
wp acorn publish:base-files
wp acorn publish:acf

Each command published files that are used on most sites.

An Optional Template Can Be Added To Any Make Command

wp acorn make:flex ComponentName template

Where template is the name of the template you would like to be used, if omitted a default is used.

Template Options

default
hero