Class CKCode

constructor

• new CKCode(options): CKCode

• Configure CKCode.

  Parameters

  • options: PartialObjectDeep<CKCodeSettings, {}>

    The CKCode settings.

  Returns CKCode

instances

Static getInstances

• getInstances(tag?): ICodeCell[]

• Get all instances of CKCode on the page.

  Parameters

  • tag: string = CKCodeCell.tag

    The tag to search for.

  Returns ICodeCell[]

  An array of CKCode instances.

Static migrateConfig

• migrateConfig(options): PartialObjectDeep<IConfig, {}>

• Convert legacy settings to new settings.

  Parameters

  • options: PartialObjectDeep<CKCodeSettings, {}>

    The legacy settings.

  Returns PartialObjectDeep<IConfig, {}>

  The new settings.

Static ready

• ready(callback): void

• This is roughly equivalent to JQuery's $(document).ready(). It will call the callback when the DOM is ready.

  Parameters

  • callback: (() => void)

    The callback to call when the DOM is ready.

    • • (): void

      • Returns void

  Returns void