toddmotto/angularjs-styleguide
Angularjs Styleguide
This is a style guide for structuring AngularJS applications using a component-based architecture. It provides a set of conventions for organizing code into self-contained modules, each encapsulating its own logic, templates, and routing. The guide promotes a modular application structure built from root, component, common, and feature modules to improve maintainability and reusability.
The guide establishes a one-way data flow pattern where parent components pass data to children through bindings, and children communicate changes back up through events. It distinguishes between stateful components that fetch data from services and stateless components that receive data through input bindings. Business logic and API calls are encapsulated in injectable service classes, separate from component controllers.
For DOM manipulation, the guide restricts directives to attribute-based decoration for event handling and element manipulation, avoiding templates or controllers. It also recommends co-locating component-specific stylesheets within module definitions. The guide covers component-based routing with resolved data mapped directly to component bindings for view initialization.
Features
- AngularJS - Provides comprehensive style guidelines for structuring AngularJS applications with modular components and one-way data flow.
- Component-Based Architectures - Organizes code into self-contained modules that each encapsulate logic, templates, and routing for maintainability.
- Modular - Provides guidelines for grouping related logic, templates, and routing into self-contained modules.
- Module Organization - Describes structuring an application into root, component, and common modules for maintainability.
- AngularJS Module Organizations - Organizes AngularJS code into root, component, common, and feature modules for maintainability and scalability.
- Component-Based Module Organizations - Organizes code into self-contained modules that encapsulate logic, templates, and routing for maintainability.
- Stateless Functional Components - Composes components that receive data through input bindings and emit events back to parent components without managing state.
- Data-Fetching Stateful Components - Composes components that fetch data from backend services and pass it down to child components without mutating state.
- Feature Modules with Routing - Encapsulates each feature block in its own module with its own routing and logic.
- Service Injection Patterns - Encapsulates reusable business logic and API calls in service classes injected into component controllers.
- Module Hierarchies - Structures applications into root, component, common, and low-level modules for predictable code organization.
- Application Bootstrap Modules - Creates a top-level module that bootstraps the app, imports submodules, and defines the base component with a routing outlet.
- Modular Project Structures - Organizes an application into root, component, common, and low-level modules with encapsulated logic.
- AngularJS - Divides AngularJS apps into root, common, component, and feature modules for maintainability and reusability.
- AngularJS Component Architectures - Provides a complete component architecture for AngularJS with stateful and stateless component patterns.
- AngularJS Modular Architectures - Defines a complete modular architecture for AngularJS applications with root, component, common, and feature modules.
- Business Logic Encapsulations - Encapsulates reusable logic, such as API calls, inside an ES2015 class and injects it into component controllers.
- Stateful and Stateless Component Separation - Separates components into stateful data-fetchers and stateless presenters with event-based communication.
- Component Binding Resolvers - Defines routing logic within components and maps resolved data to component bindings for view initialization.
- One-Way Data Bindings - Passes data into components with one-way bindings and sends changes back up through event objects.
- Attribute-Based Directives - Provides conventions for attribute-only directives that handle events and manipulate elements without templates.
- Directives and Decorators - Decorates the DOM with directives that handle events and manipulate elements without templates or controllers.
- Attribute-Based DOM Decorators - Provides attribute-only directives for DOM event handling and manipulation without templates or controllers.
- Attribute-Only Directive Decorations - Decorates the DOM with attribute-only directives that add custom events or manipulate existing component templates.
- Attribute-Only DOM Directives - Uses attribute-only directives for DOM event handling and manipulation without templates or controllers.
- DOM-Only Directive Scopes - Restricts directives to custom DOM events and manipulation, avoiding templates, controllers, or scope bindings.
- Service-Backed Stateful Components - Builds components that fetch data from a backend service and pass it to child components without mutating state directly.
- Application-Specific Container Modules - Groups all application-specific components into a single container module for internal use.
- AngularJS - Wraps AngularJS business logic and API calls in injectable service classes separate from component controllers.
- Reusable Component Architectures - Groups all reusable components into a single container module for easy import across applications.
- App-Specific Component Separations - Advocates dividing components into shared and app-specific modules for clear separation of concerns.
- Component-Based Route Definitions - Defines routing logic within components and maps resolved data to component bindings for view initialization.
- Route Resolvers - Defines routing logic within component modules and maps resolved data to component bindings.
- Service-Fetching Stateful Components - Composes components that fetch data from services and delegate mutation to child components.
- Attribute-Only Directive Restrictions - Restricts directives to attribute-based DOM decoration and event handling, avoiding templates or controllers.
- Component-Bound Route Resolutions - Routes components by defining routing logic inside their module and mapping resolved data to bindings.
- Code Quality and Patterns - Best practices and style guide for AngularJS development.
