• feature-u (2.0.0)
  • Introduction
  • Getting Started
    • Install
    • Access
    • Potential Need for Polyfills
  • Basic Concepts
    • Feature Based Development
      • Segregating Features
      • Feature Goals
        • Feature Runtime Consolidation
        • Feature Collaboration
    • The feature-u Solution
      • launchApp()
      • Feature Object
      • aspects
      • Running the App
        • App Initialization
        • Framework Configuration
        • Launching Your Application
      • Cross Feature Communication
      • Feature Based UI Composition
        • Resource Contracts
      • Feature Enablement
    • In Summary
  • Benefits
  • Usage
    • Directory Structure
    • Feature Object
    • Feature Accumulation
    • launchApp()
    • Real Example
  • A Closer Look
    • aspects
    • Feature & aspect content
      • Built-In aspects
      • Extendable aspects
    • Launching Your Application
      • Export fassets
      • React Registration
  • Application Life Cycle Hooks
    • appWillStart
      • Injecting DOM Content
    • appDidStart
  • Cross Feature Communication
    • Basic Concepts: fassets
      • fassets definition
      • fassets usage
      • federated namespace
    • UI Composition
      • useFassets() Hook
      • withFassets() HoC
      • Resource Contracts
      • Wildcards
        • Wildcard Processing
        • Resource Order
        • React Keys
    • Resource Validation
    • Does Feature Exist
    • fassets recap: Push or Pull
    • Obtaining fassets object
      • fassets parameter
      • Obtain fassets from Hooks
      • Inject fassets comp props
      • Managed Code Expansion
      • import fassets
  • Feature Based Routes
    • react-router
    • feature-router
  • Feature Enablement
    • How it works
    • Existence and Dependencies
  • Best Practices
    • Avoid Cross Feature Imports
    • Feature Name
    • Feature State Location
  • Core API
    • createFeature()
      • Built-In aspects ...
        • fassets aspect
        • appWillStart()
        • appDidStart()
    • expandWithFassets()
      • expandWithFassetsCB()
    • launchApp()
      • registerRootAppElm()
    • useFassets()
    • withFassets()
      • mapFassetsToPropsStruct
      • mapFassetsToProps()
    • Misc ...
      • assertNoRootAppElm()
    • Object Refs ...
      • Fassets
        • get()
        • hasFeature()
      • fassetValidations
      • Feature
      • Aspect
      • AspectContent
  • Extending feature-u
    • Locating Extensions
    • Aspect Object
    • Defining rootAppElm
    • Aspect Cross Communication
    • Aspect Life Cycle Methods
      • name
      • genesis()
      • validateFeatureContent()
      • expandFeatureContent()
      • assembleFeatureContent()
      • assembleAspectResources()
      • initialRootAppElm()
      • injectRootAppElm()
      • config
      • additionalMethods()
    • Extension API
      • createAspect()
      • extendAspectProperty()
      • extendFeatureProperty()
      • Object Refs ...
        • Fassets
          • get()
          • hasFeature()
        • fassetValidations
        • Feature
        • Aspect
        • AspectContent
  • Distribution
  • Why feature-u?
  • Revision History
    • v2.0.0 (May 10, 2019)
      • Full Docs
    • v1.0.1 (September 5, 2018)
      • Full Docs
    • v1.0.0 (August 14, 2018)
      • Full Docs
      • Migration Notes
    • v0.1.3 (July 2, 2018)
      • Full Docs
    • v0.1.0 (March 6, 2018)
      • Full Docs
  • MIT License
  • Published with GitBook

Core API

Core API

The following list summarizes the Core API. For your convenience this list:

  1. summarizes the functional API signatures
  2. includes related callback/hooks (indented)
  3. links to the detailed API docs

Core API Summary

  • createFeature({name, [enabled], [fassets], [appWillStart], [appDidStart], [extendedAspects]}): Feature
    • fassets aspect
    • appWillStart({fassets, curRootAppElm}): rootAppElm | falsy
    • appDidStart({fassets, [appState], [dispatch]}): void
  • expandWithFassets(expandWithFassetsCB): expandWithFassetsCB
    • expandWithFassetsCB(fassets): AspectContent
  • launchApp({[aspects], features, registerRootAppElm}): Fassets
    • registerRootAppElm(rootAppElm, fassets): void
  • useFassets(fassetsKey | mapFassetsToPropsStruct): Fassets | fassets-resource | fassetsProps
  • withFassets({mapFassetsToProps, [component]}): HoC | HoF
    • mapFassetsToPropsStruct
    • mapFassetsToPropsFn
  • Misc ...
    • assertNoRootAppElm(rootAppElm, className)

Object Refs ...

  • Fassets object
    • Fassets.get()
    • Fassets.hasFeature()
  • fassetValidations
  • Feature
  • Aspect
  • AspectContent

results matching ""

    No results matching ""