@acoustic-content-sdk/redux-feature-undo

Implementation of a redux feature to manage undo and redo.

Usage no npm install needed!

<script type="module">
  import acousticContentSdkReduxFeatureUndo from 'https://cdn.skypack.dev/@acoustic-content-sdk/redux-feature-undo';
</script>

README

npm

Implementation of a redux feature to manage undo and redo.

API Documentation

Home > @acoustic-content-sdk/redux-feature-undo

redux-feature-undo package

Implementation of a redux feature to manage undo and redo..

Interfaces

Interface Description
UndoFeatureState

Variables

Variable Description
ACTION_REDO_AUTH_CONTENT_INTERNAL
ACTION_REDO_AUTH_CONTENT
ACTION_UNDO_AUTH_CONTENT_INTERNAL
ACTION_UNDO_AUTH_CONTENT
ACTION_UNDO_SET_AUTH_CONTENT_INTERNAL
MODULE Module name
redoAuthoringContentAction
redoAuthoringContentInternalAction The parameter is the current version of the content item
selectNextUndoItem Selects the next item from the redo history if it exists
selectPreviousUndoItem Selects the last item from the undo history if it exists
selectRedoEnabled Tests if we have redo actions
selectUndoEnabled Tests if we have undo actions
selectUndoFeature Select the URL config feature
selectUndoScope
undoAuthoringContentAction
undoAuthoringContentInternalAction The parameter is the current version of the content item
undoFeature Exposes the feature module selector
undoSetAuthoringContentInternalAction The parameter is the current version of the content item
VERSION Version and build number of the package

Type Aliases

Type Alias Description
RedoAuthoringContentAction
RedoAuthoringContentInternalAction
UndoAuthoringContentAction
UndoAuthoringContentInternalAction
UndoSetAuthoringContentInternalAction

Home > @acoustic-content-sdk/redux-feature-undo > UndoFeatureState

UndoFeatureState interface

Signature:

export interface UndoFeatureState 

Properties

Property Type Description
undo UndoState

Home > @acoustic-content-sdk/redux-feature-undo > ACTION_REDO_AUTH_CONTENT_INTERNAL

ACTION_REDO_AUTH_CONTENT_INTERNAL variable

Signature:

ACTION_REDO_AUTH_CONTENT_INTERNAL = "ACTION_REDO_AUTH_CONTENT_INTERNAL"

Home > @acoustic-content-sdk/redux-feature-undo > ACTION_REDO_AUTH_CONTENT

ACTION_REDO_AUTH_CONTENT variable

Signature:

ACTION_REDO_AUTH_CONTENT = "ACTION_REDO_AUTH_CONTENT"

Home > @acoustic-content-sdk/redux-feature-undo > ACTION_UNDO_AUTH_CONTENT_INTERNAL

ACTION_UNDO_AUTH_CONTENT_INTERNAL variable

Signature:

ACTION_UNDO_AUTH_CONTENT_INTERNAL = "ACTION_UNDO_AUTH_CONTENT_INTERNAL"

Home > @acoustic-content-sdk/redux-feature-undo > ACTION_UNDO_AUTH_CONTENT

ACTION_UNDO_AUTH_CONTENT variable

Signature:

ACTION_UNDO_AUTH_CONTENT = "ACTION_UNDO_AUTH_CONTENT"

Home > @acoustic-content-sdk/redux-feature-undo > ACTION_UNDO_SET_AUTH_CONTENT_INTERNAL

ACTION_UNDO_SET_AUTH_CONTENT_INTERNAL variable

Signature:

ACTION_UNDO_SET_AUTH_CONTENT_INTERNAL = "ACTION_UNDO_SET_AUTH_CONTENT_INTERNAL"

Home > @acoustic-content-sdk/redux-feature-undo > MODULE

MODULE variable

Module name

Signature:

MODULE = "@acoustic-content-sdk/redux-feature-undo"

Home > @acoustic-content-sdk/redux-feature-undo > redoAuthoringContentAction

redoAuthoringContentAction variable

Signature:

redoAuthoringContentAction: Generator<RedoAuthoringContentAction>

Home > @acoustic-content-sdk/redux-feature-undo > redoAuthoringContentInternalAction

redoAuthoringContentInternalAction variable

The parameter is the current version of the content item

Signature:

redoAuthoringContentInternalAction: UnaryFunction<ScopedUndoItems, RedoAuthoringContentInternalAction>

Home > @acoustic-content-sdk/redux-feature-undo > selectNextUndoItem

selectNextUndoItem variable

Selects the next item from the redo history if it exists

Signature:

selectNextUndoItem: UnaryFunction<ScopedUndoState, UndoItems>

Home > @acoustic-content-sdk/redux-feature-undo > selectPreviousUndoItem

selectPreviousUndoItem variable

Selects the last item from the undo history if it exists

Signature:

selectPreviousUndoItem: UnaryFunction<ScopedUndoState, UndoItems>

Home > @acoustic-content-sdk/redux-feature-undo > selectRedoEnabled

selectRedoEnabled variable

Tests if we have redo actions

Signature:

selectRedoEnabled: UnaryFunction<ScopedUndoState, boolean>

Home > @acoustic-content-sdk/redux-feature-undo > selectUndoEnabled

selectUndoEnabled variable

Tests if we have undo actions

Signature:

selectUndoEnabled: UnaryFunction<ScopedUndoState, boolean>

Home > @acoustic-content-sdk/redux-feature-undo > selectUndoFeature

selectUndoFeature variable

Select the URL config feature

Signature:

selectUndoFeature: import("rxjs").UnaryFunction<Record<string, any>, Record<string, import("./undo.state").ScopedUndoState>>

Home > @acoustic-content-sdk/redux-feature-undo > selectUndoScope

selectUndoScope variable

Signature:

selectUndoScope: UnaryFunction<string, UnaryFunction<UndoState, ScopedUndoState>>

Home > @acoustic-content-sdk/redux-feature-undo > undoAuthoringContentAction

undoAuthoringContentAction variable

Signature:

undoAuthoringContentAction: Generator<UndoAuthoringContentAction>

Home > @acoustic-content-sdk/redux-feature-undo > undoAuthoringContentInternalAction

undoAuthoringContentInternalAction variable

The parameter is the current version of the content item

Signature:

undoAuthoringContentInternalAction: UnaryFunction<ScopedUndoItems, UndoAuthoringContentInternalAction>

Home > @acoustic-content-sdk/redux-feature-undo > undoFeature

undoFeature variable

Exposes the feature module selector

Signature:

undoFeature: import("@acoustic-content-sdk/redux-store").ReduxFeatureModule<Record<string, import("./undo.state").ScopedUndoState>, UndoFeatureState, import("redux").AnyAction, import("redux").AnyAction, any>

Home > @acoustic-content-sdk/redux-feature-undo > undoSetAuthoringContentInternalAction

undoSetAuthoringContentInternalAction variable

The parameter is the current version of the content item

Signature:

undoSetAuthoringContentInternalAction: UnaryFunction<ScopedUndoItems, UndoSetAuthoringContentInternalAction>

Home > @acoustic-content-sdk/redux-feature-undo > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}

Home > @acoustic-content-sdk/redux-feature-undo > UndoFeatureState > undo

UndoFeatureState.undo property

Signature:

[UNDO_FEATURE]: UndoState;