Merge pull request #6 from JuanZoran/experimental

更新了README说明和demo

.gitignore

@@ -2,3 +2,5 @@ lua/Trans/util/
 lua/Trans/test/
 note/
 go/
+demo.mp4
+screenshot.gif

README.md

@@ -21,6 +21,7 @@
   - 悬浮大小
   - 排版顺序
   - 弹窗大小
+  - `舒服窗口动画`
   - etc (更多可以查看[配置](#配置))
 - **完全离线** 的单词翻译体验 (可能后面会支持在线翻译)
 - 支持显示:
@@ -37,7 +38,7 @@
 - 本地词库单词量: `430w`
   
 ## 屏幕截图
-![ScreenShot](./screenshot.gif)
+https://user-images.githubusercontent.com/107862700/213752097-2eee026a-ddee-4531-bf80-ba2cbc8b44ef.mp4
 
 
 ## 安装
@@ -46,6 +47,7 @@
 - sqlite.lua: 操作数据库所用的库
 - sqlite3: 数据库
 
+
 由于目前本人只使用 `Packer.nvim` 作为包管理插件, 所以这里以Packer为例:  
 **考虑将以下代码复制到的Packer Startup中:**
 ```lua
@@ -54,9 +56,12 @@ use {
     run = 'bash ./install.sh',
     requires = 'kharji/sqlite.lua',
     -- 如果你不需要任何配置的话, 可以直接按照下面的方式启动
-    config = require'Trans'.setup
+    config = function ()
+        require'Trans'.setup{
+            -- your configuration here
+        }
+    end
 }
-
 ```
 
 **如果你想要使用Packer的惰性加载，这里有一个例子**  
@@ -103,23 +108,50 @@ use {
 ```lua
 require'Trans'.setup {
     view = {
-        input = 'float',
+        i = 'float',
         n = 'hover',
         v = 'hover',
     },
-    window = {
+    hover = {
+        width = 36,
+        height = 26,
         border = 'rounded',
-        animation = true,
+        title = {
-        hover = {
+            { '', 'TransTitleRound' },
-            width = 36,
+            { ' Trans', 'TransTitle' },
-            height = 26,
+            { '', 'TransTitleRound' },
         },
-        float = {
+        keymap = {
-            width = 0.8,
+            -- TODO :
-            height = 0.8,
+            pageup = '[[',
+            pagedown = ']]',
+            pin = '_', -- 将窗口固定在右上角, 参考demo
+            close = '+',
         },
+        animation = {
+            open = 'slid', -- 可选的样式: slid , fold 
+            close = 'slid',
+            interval = 12, -- 动画的帧间隔
+        }
+    },
+    float = {
+        width = 0.8,
+        height = 0.8,
+        border = 'rounded',
+        title = {
+            { '', 'TransTitleRound' },
+            { ' Trans', 'TransTitle' },
+            { '', 'TransTitleRound' },
+        },
+        keymap = {
+            quit = 'q',
+        },
+        animation = {
+            open = 'fold',
+            close = 'fold',
+            interval = 10,
+        }
     },
-
     order = {
         -- offline = {
         'title',
@@ -134,29 +166,22 @@ require'Trans'.setup {
         -- },
     },
     icon = {
-        title = ' ', --  
         star = '',
-        -- notfound = ' ',
-        -- yes = ' ',
-        -- no = ' '
-        -- star = '⭐',
         notfound = '❔',
         yes = '✔️',
         no = '❌'
+        -- star = '⭐',
+        -- notfound = '',
+        -- yes = '',
+        -- no = ''
     },
     db_path = '$HOME/.vim/dict/ultimate.db',
+
     -- TODO :
     -- engine = {
     --     -- TODO
     --     'offline',
     -- }
-    keymap = {
-        -- TODO : More action support
-        hover = {
-            pageup = '[[',
-            pagedown = ']]',
-        },
-    },
     -- history = {
     --     -- TOOD
     -- }

lua/Trans/init.lua

@@ -6,7 +6,6 @@ M.conf = {
         n = 'hover',
         v = 'hover',
     },
-    -- animation = true,
     hover = {
         width = 36,
         height = 26,
@@ -24,6 +23,8 @@ M.conf = {
             close = '+',
         },
         animation = {
+            -- open = 'fold',
+            -- close = 'fold',
             open = 'slid',
             close = 'slid',
             interval = 12,
@@ -42,9 +43,9 @@ M.conf = {
             quit = 'q',
         },
         animation = {
-            open = 'slid',
+            open = 'fold',
-            close = 'slid',
+            close = 'fold',
-            interval = 8,
+            interval = 10,
         }
     },
     order = {
@@ -54,8 +55,6 @@ M.conf = {
         'pos',
         'exchange',
         'translation',
-        -- NOTE :如果你想限制某个组件的行数，可以设置max_size
-        -- { 'Definition', max_size = 4 },
         'definition',
         -- },
         -- online = {

lua/Trans/view/float.lua

@@ -1,12 +1,25 @@
 local m_window
 local m_result
 
+local function set_title()
+    local title = m_window.title
+    local github = 'https://github.com/JuanZoran/Trans.nvim'
+
+    -- TODO :config this
+    title:center_line(github, '@text.uri')
+end
+
+local action = {
+    quit = function ()
+        m_window:try_close()
+    end,
+}
+
 
 return function(word)
     -- TODO :online query
-    m_result    = require('Trans.query.offline')(word)
-    m_window    = require('Trans.window')
     local float = require('Trans').conf.float
+    m_result    = require('Trans.query.offline')(word)
 
     local opt = {
         relative = 'editor',
@@ -17,12 +30,15 @@ return function(word)
         row      = math.floor((vim.o.lines - float.height) / 2),
         col      = math.floor((vim.o.columns - float.width) / 2),
     }
+    m_window    = require('Trans.window')(true, opt)
+    m_window.animation = float.animation
 
-    -- 创建窗口
+    set_title()
-    m_window.init(true, opt)
+    m_window:draw()
-    m_window.center('https:github.com/JuanZoran/Trans.nvim', '@text.uri') -- only show color with treesiter
+    m_window:open()
-    m_window.draw()
+    m_window:bufset('bufhidden', 'wipe')
-    m_window.map('q', function()
+
-        m_window.try_close(float.animation)
+    for act, key in pairs(float.keymap) do
-    end)
+        m_window:map(key, action[act])
+    end
 end

lua/Trans/view/hover.lua

@@ -176,6 +176,7 @@ local process = {
 
 
 local cmd_id
+local pin = false
 
 local try_del_keymap = function()
     for _, key in pairs(conf.hover.keymap) do
@@ -184,8 +185,8 @@ local try_del_keymap = function()
 end
 
 
-local pin = false
+local action
-local action = {
+action = {
     pageup = function()
         m_window:normal('gg')
     end,
@@ -217,14 +218,19 @@ local action = {
             m_window:bufset('bufhidden', 'wipe')
             vim.keymap.del('n', conf.hover.keymap.pin, { buffer = true })
 
+
+
+            --- NOTE : 只允许存在一个pin窗口
             local buf = m_window.bufnr
             pin = true
-
+            api.nvim_create_autocmd({ 'BufWipeOut', 'BufLeave' }, {
-            api.nvim_create_autocmd('BufWipeOut', {
                 callback = function(opt)
-                    if opt.buf == buf then
+                    if opt.event == 'BufLeave' or opt.buf == buf then
                         pin = false
                         api.nvim_del_autocmd(opt.id)
+                        if opt.event == 'BufLeave' then
+                            action.close()
+                        end
                     end
                 end
             })
@@ -283,11 +289,11 @@ return function(word)
     cmd_id = api.nvim_create_autocmd(
         { 'InsertEnter', 'CursorMoved', 'BufLeave', }, {
         buffer = 0,
-        once = true,
         callback = function()
             m_window:set('wrap', false)
             m_window:try_close()
             try_del_keymap()
+            api.nvim_del_autocmd(cmd_id)
         end,
     })
 

lua/Trans/window.lua

@@ -1,6 +1,5 @@
 local api = vim.api
 
-
 ---@diagnostic disable-next-line: duplicate-set-field
 function string:width()
     ---@diagnostic disable-next-line: param-type-mismatch
@@ -112,11 +111,12 @@ local window = {
             local handler
             local function wrap(name, target)
                 local count = 0
+                local action = 'nvim_win_set_' .. target
                 return function()
                     if count < self[target] then
                         busy = true
                         count = count + 1
-                        api['nvim_win_set_' .. target](self.winid, count)
+                        api[action](self.winid, count)
                         vim.defer_fn(handler[name], animation.interval)
 
                     else
@@ -155,11 +155,12 @@ local window = {
                 local handler
                 local function wrap(name, target)
                     local count = self[target]
+                    local action = 'nvim_win_set_' .. target
                     return function()
                         if count > 1 then
                             busy = true
                             count = count - 1
-                            api['nvim_win_set_' .. target](self.winid, count)
+                            api[action](self.winid, count)
                             vim.defer_fn(handler[name], animation.interval)
 
                         else
@@ -191,7 +192,7 @@ local window = {
         end
     end,
 
-    reopen = function (self, entry, opt, callback)
+    reopen = function(self, entry, opt, callback)
         check_busy()
         self.config.win = nil
         if opt then
@@ -240,6 +241,7 @@ return function(entry, option)
         zindex    = 100,
         style     = 'minimal',
     }
+
     for k, v in pairs(option) do
         opt[k] = v
     end
@@ -277,6 +279,7 @@ return function(entry, option)
 
     win:set('winhl', 'Normal:TransWin,FloatBorder:TransBorder')
     win:bufset('filetype', 'Trans')
+    win:bufset('buftype', 'nofile')
 
     ---@diagnostic disable-next-line: return-type-mismatch
     return win