npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tidbcloud/tisqleditor-react

v0.0.6

Published

tisqleditor react component

Downloads

8

Readme

@tidbcloud/tisqleditor-react

This package provides a react component wrap for SQLEditorInstance from @tidbcloud/tisqleditor.

Try it

Installation

npm install @tidbcloud/tisqleditor-react

You need to install all its peer dependencies manually as well, such as @codemirror/view, @codemirror/state.

Usage

@tidbcloud/tisqleditor-react supports multiple CodeMirror instances, it uses EditorCacheProvider as the context provider to cache the instances, then you can access all the cached editor instances anywhere inside the provider. You can put the provider in a proper place.

import { EditorCacheProvider } from '@tidbcloud/tisqleditor-react'

export default function () {
  return (
    <EditorCacheProvider>
      <App />
    </EditorCacheProvider>
  )
}

When EditorCacheProvider unmounts, it will clear all the cached editor instances.

import { SQLEditor } from '@tidbcloud/tisqleditor-react'

export function () {
  // ...

  return (
    <SQLEditor
      className="h-full"
      editorId={activeFile.id}
      doc={activeFile.content}
      sqlConfig={sqlConfig}
      theme={isDark ? oneDark : bbedit}
      extraExts={extraExts}
    />
  )
}

Inside the SQLEditor, it will check whether the editor instance already exists from the cached editor instances by editorId, if doesn't exist, it will create a new editor instance, and add to the cache automatically, else use the existed editor instance directly.

When you want to remove an editor instance from the cache, for example, close an opened SQL file, you need to do it manually.

import { useEditorCacheContext } from '@tidbcloud/tisqleditor-react'

export function OpenedFilesTabs() {
  const {
    state: { openedFiles }
  } = useFilesContext()
  const cacheCtx = useEditorCacheContext()

  function handleCloseFile(file: IFile) {
    // ...

    // remove from cache
    cacheCtx.deleteEditor(file.id)
  }

  return (
    <div>
      {openedFiles.map((f) => (
        <div key={f.id}>
          <p>{f.name}</p>
          <button
            onClick={() => {
              handleCloseFile(f)
            }}
          >
            x
          </button>
        </div>
      ))}
    </div>
  )
}

Notice: if you don't need to support multiple CodeMirror instances, aka you don't need to edit multiple SQL files at the same time, then you don't need to use the <EditorCacheProvider>, just to use <SQLEditor> component.

API

EditorCacheProvider

  • useEditorCacheContext(): get the cache context
  • cacheCtx.addEditor(editorId, instance): add new editor instance
  • cacheCtx.getEditor(editorId): get the cached editor instance by editorId
  • cacheCtx.deleteEditor(editorId): remove the editor instance from cache
  • cacheCtx.clearEditors(): clear all cached editor instances

SQLEditor Props

  • className: CodeMirror root container css class
  • editorId: editor id, used to differ multiple editor instances
  • doc: editor initial content
  • sqlConfig: config for SQL dialect, schemas, tables
  • theme: editor theme, @tidbcloud/codemirror-extensions-themes provides 2 simple themes, bbedit for light mode, oneDark for dark mode, you can choose any other themes from third-party libraries or customize it by self
  • extraExts: any other extra CodeMirror extensions you want to use, @tidbcloud/tisqleditor-react install some builtin extensions, likes @codemirror/lang-sql, @tidbcloud/codemirror-extension-sql-parser, @tidbcloud/codemirror-extension-cur-sql