Git Product home page Git Product logo

docsqa-ui's Introduction

<qa-bot>

<qa-bot> is the UI part of DocQA. It's a web component built with Lit.

<qa-bot> is just a HTML element. You can have it anywhere you can use HTML!

<qa-bot></qa-bot>

Configure with attributes

<qa-bot> can be configured with attributes in plain HTML.

<qa-bot 
    server="https://jina-ai-jina.docsqa.jina.ai" 
    open
    site="https://docs.jina.ai" 
    target="_blank"
    avatar-src="https://jina.ai/assets/images/logo.svg"
    >
</qa-bot>

Install

<qa-bot> is distributed on npm, so you can install it locally or use it via npm CDNs like jsdelivr.

<script src="https://cdn.jsdelivr.net/npm/qabot"></script>

docsqa-ui's People

Contributors

hanxiao avatar jina-bot avatar nan-wang avatar nomagick avatar shazhou2015 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docsqa-ui's Issues

Add CI/CD for <qa-bot>

  • Eslint
  • UI tests
    UI tests is just gonna compare html texts. Hardly make any sense.
    There is hardly any behaviour testable by javascript, just tons of implementation details.
  • GitHub workflow for test
  • GitHub workflow for deployment

Improve layout

We want to improve the layout and be able to reuse it, render ahref as listitem intead
image (1)
image

UI in mobile

New layout is not yet tested on mobile. Let's make sure it works

For smaller screens:

  • Bot should not open automatically after redirect but hide automatically

For mobile devices that will change the window size when opening virtual keyboard:

  • Detect if scrolled to bottom
  • If bottom reached, automatically scroll to bottom after window resize

For devices that don't have a physical keyboard:

  • Don't automatically focus on the textarea

For devices that don't have a mouse:

  • Fix hover effect

For portrait orientation larger screens:

  • Bot height should be limited

new default feedback text for thumbsup and thumbsdown

We want to change to have different response feedback for :
thumbsup : Thank you for providing your feedback, happy to help! # ๐Ÿ˜€
thumbsdown : Thank you for providing your feedback, we will continue to improve. :man-bowing:

Create tests for UI

Now UI is loaded with features.

We should create unit tests for this project.

Customize tip

  • customize to show/hide tip when loading firstly
  • customize tip text

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.