Note Traits

Summary

Gotchas

• the traits property is represented as traitIds on disk
  • ../code/dendron/packages/common-all/src/dnode.ts (Private)

    serializeExplicitProps {
        if (cleanProps.traits) {
        propsWithTrait = {
            ...cleanProps,
            traitIds: cleanProps.traits.map((value) => value),
        };
        }    
    }
    

Lifecycle

Activate

• ../packages/plugin-core/src/workspace/workspaceActivator.ts (Private)

init {
    traitRegistrar.initialize
}

• ../packages/plugin-core/src/services/NoteTraitManager.ts (Private)

initialize {
    setupSavedTraitsFromFS
}

setupSavedTraitsFromFS {
    asyncLoopOneAtATime {
        setupTraitFromJSFile
    }
}

setupTraitFromJSFile {
    newNoteTrait = new UserDefinedTraitV1
    newNoteTrait.initialize
    registerTrait(newNoteTrait)
}

registerTrait {
    // map of traits
    registeredTraits.set(trait.id, trait)
    cmdRegistar.registerCommandForTrait(trait)
}

• ../packages/plugin-core/src/services/CommandRegistrar.ts (Private)

registerCommandForTrait {
    cmd = new CreateNoteWithTraitCommand(commandId, trait)
}

Lifecycle Old

Registering a trait

• ../packages/plugin-core/src/workspace.ts (Private)

setupTraits {
    files := 
    files.forEach file => {
        newNoteTrait = new UserDefinedTraitV1
        _traitRegistrar.registerTrait(newNoteTrait)
    }
}

• ../packages/plugin-core/src/traits/UserDefinedTraitV1.ts (Private)

UserDefinedTraitV1

Creating a note

• init: ../packages/plugin-core/src/workspace.ts (Private)

• command extends from CreateNoteWithTraitCommand > ../packages/plugin-core/src/commands/CreateNoteWithTraitCommand.ts (Private)

gatherInputs { 
    if trait.OnWillCreate?.setNameModifier
    ...
}

Reference

• Note Trait Interface: ../packages/common-all/src/types/noteTrait.ts (Private)

Past Tasks

• enhance(structure): support xvault template in note traits by Harshita-mindfire · Pull Request #3329 · dendronhq/dendron

---

Backlinks

• Ref