跳转到主要内容

Dash的纯HTML组件

项目描述

注意

从Dash 2开始,dash-html-components的开发已迁移到主要的Dash仓库

此包存在是为了向后兼容


dash-html-components

Dash的纯HTML组件

安装依赖项

  1. 创建虚拟环境并激活。

    $ virtualenv venv
    $ venv/bin/activate
    

    注意:Windows下为venv\Scripts\activate

  2. 安装构建组件所需的Python包。

    $ pip install -r dev-requirements.txt
    
  3. 生成组件并安装npm包

    $ npm install
    

生成HTML组件

位于src/components中的组件,以及src/index.js中的导出索引,都是通过从scripts/中的元素定义程序生成的。要重新生成

$ npm run generate-components

属性列表通过抓取MDN HTML 属性参考进行重新生成。

注意:当您运行 npm install 时,这一步已经为您完成。

开发

在 Dash 中测试您的组件

  1. 注意变更

     $ npm run build:watch
    
  2. 本地安装模块(每次更改后)

     # Generate metadata, and build the JavaScript bundle
     $ npm run install-local
    
     # Now you're done. For subsequent changes, if you've got `npm run build:watch`
     $ python setup.py install
    
  3. 运行您想要测试的 Dash 布局

     # Import dash_html_components to your layout, then run it:
     $ python my_dash_layout.py
    

本地安装 Python 包

在发布到 PyPi 之前,您可以在本地测试模块的安装

# Install in `site-packages` on your machine
$ npm run install-local

本地卸载 Python 包

$ npm run uninstall-local

贡献

请参阅贡献指南,了解如何为此项目做出贡献的指导原则。

创建生产构建并发布

  1. 构建您的代码

    $ npm run build
    
  2. 创建 Python 打包文件

    $ python setup.py sdist
    

    此分发打包文件将在 dist/ 文件夹中生成

  3. 通过将其复制到新环境并本地安装来测试您的打包文件

    $ pip install dash-html-components-<new-version>.tar.gz
    
  4. 如果它正常工作,那么您可以将组件发布到 NPM 和 PyPI

    1. 在 PyPI 上发布
      $ twine upload dist/*
      
    2. 清理 dist 文件夹(可选)
      $ rm -rf dist
      
    3. 在 NPM 上发布(如果 publish_on_npm 中选择 False,则可选)
      $ npm publish
      
      将您的组件发布到 NPM 将使 JavaScript 打包文件可在 unpkg CDN 上使用。默认情况下,Dash 从远程 unpkg CDN 服务器组件库的 CSS 和 JS,因此如果您尚未将组件包发布到 NPM,您需要将 serve_locally 标志设置为 True(除非您在 publish_on_npm 中选择 False)。我们最终会将 serve_locally=True 设置为默认值,请关注此问题的进展

项目详情


发行历史 发布通知 | RSS 源

下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分发

dash_html_components-2.0.0.tar.gz (3.8 kB 查看哈希值)

上传时间

构建分发

dash_html_components-2.0.0-py3-none-any.whl (4.1 kB 查看哈希值)

上传时间 Python 3