openDrawerLayout

2022-06-13 13:56 更新

打開一個抽屜式側(cè)滑 window,可以從當(dāng)前 window 的左右邊緣滑動拉出側(cè)滑 window。

此方法能夠使用 openWin 方法的所有參數(shù),在此基礎(chǔ)上增加了 leftPane、rightPane 等參數(shù),可以通過 api.closeWin()方法來關(guān)閉整個抽屜式側(cè)滑。

實例widget下載地址

openDrawerLayout({params})

params

leftPane:

  • 類型:JSON 對象
  • 默認值:無
  • 描述:左邊側(cè)滑 window
  • 內(nèi)部字段:

{
    edge:60,                            // 左邊側(cè)滑打開后,漏出的半透明區(qū)域?qū)挾?,默認值為60。此時左邊側(cè)滑window的寬度為屏幕寬度減去edge
    name:'',                            // window名字(字符串類型)
    url:'',                             // 頁面地址,可以為本地文件路徑,支持相對路徑和絕對路徑,以及widget://、fs://等協(xié)議路徑,也可以為遠程地址
    pageParam:{},                       //(可選項)頁面參數(shù),頁面中可以通過api.pageParam獲取,JSON對象
    bgColor:'',                         //(可選項)背景色,支持圖片和顏色,格式為#fff、#ffffff、rgba(r,g,b,a)等,圖片路徑支持fs://、widget://等APICloud自定義文件路徑協(xié)議,同時支持相對路徑
    bounces:false,                      //(可選項)是否彈動,默認值:若在 config.xml 里面配置了pageBounce,則默認值為配置的值,否則為false
    scrollToTop:false,                  //(可選項)當(dāng)點擊狀態(tài)欄,頁面是否滾動到頂部。若當(dāng)前屏幕上不止一個頁面的scrollToTop屬性為true,則所有的都不會起作用。默認值:true。只iOS有效
    scrollEnabled:true                  //(可選項)頁面內(nèi)容超出后是否可以滾動,默認為true,只支持iOS
    vScrollBarEnabled:true,             //(可選項)是否顯示垂直滾動條,默認true 
    hScrollBarEnabled:true,             //(可選項)是否顯示水平滾動條,默認true
    scaleEnabled:true,                  //(可選項)頁面是否可以縮放,布爾型,默認值:false
    allowEdit:false,                    //(可選項)是否允許長按頁面時彈出選擇菜單
    softInputMode:'auto',               //(可選項)當(dāng)鍵盤彈出時,輸入框被蓋住時,當(dāng)前頁面的調(diào)整方式,只iOS有效
                                        //取值范圍:
                                        //resize      //若鍵盤蓋住輸入框,頁面會自動上移
                                        //pan         //若鍵盤蓋住輸入框,頁面不會自動上移
                                        //auto        //默認值,由系統(tǒng)決定如何處理,iOS平臺該字段等同于resize
    softInputBarEnabled:false,          //(可選項)是否顯示鍵盤上方的工具條,布爾型,默認值:true,只iOS有效
    defaultRefreshHeader:''             //(可選項)設(shè)置使用默認下拉刷新類型,取值范圍:pull、swipe
    customRefreshHeader:''              //(可選項)設(shè)置使用自定義下拉刷新模塊的名稱,設(shè)置后可以使用api.setCustomRefreshHeaderInfo方法來使用自定義下拉刷新組件
}

rightPane:

  • 類型:JSON 對象
  • 默認值:無
  • 描述:右邊側(cè)滑 window
  • 內(nèi)部字段:

{
    edge:60,                            // 右邊側(cè)滑打開后,漏出的半透明區(qū)域?qū)挾?,默認值為60。此時右邊側(cè)滑window的寬度為屏幕寬度減去edge
    name:'',                            // window名字(字符串類型)
    url:'',                             // 頁面地址,可以為本地文件路徑,支持相對路徑和絕對路徑,以及widget://、fs://等協(xié)議路徑,也可以為遠程地址
    pageParam:{},                       //(可選項)頁面參數(shù),頁面中可以通過api.pageParam獲取,JSON對象
    bgColor:'',                         //(可選項)背景色,支持圖片和顏色,格式為#fff、#ffffff、rgba(r,g,b,a)等,圖片路徑支持fs://、widget://等APICloud自定義文件路徑協(xié)議,同時支持相對路徑
    bounces:false,                      //(可選項)是否彈動,默認值:若在 config.xml 里面配置了pageBounce,則默認值為配置的值,否則為false
    scrollToTop:false                   //(可選項)當(dāng)點擊狀態(tài)欄,頁面是否滾動到頂部。若當(dāng)前屏幕上不止一個頁面的scrollToTop屬性為true,則所有的都不會起作用。默認值:true。只iOS有效
    scrollEnabled:true                  //(可選項)頁面內(nèi)容超出后是否可以滾動,默認為true,只支持iOS
    vScrollBarEnabled:true,             //(可選項)是否顯示垂直滾動條,默認true 
    hScrollBarEnabled:true,             //(可選項)是否顯示水平滾動條,默認true
    scaleEnabled:true,                  //(可選項)頁面是否可以縮放,布爾型,默認值:false
    allowEdit:false,                    //(可選項)是否允許長按頁面時彈出選擇菜單
    softInputMode:'auto'                //(可選項)當(dāng)鍵盤彈出時,輸入框被蓋住時,當(dāng)前頁面的調(diào)整方式,只iOS有效
                                        //取值范圍:
                                        //resize       //若鍵盤蓋住輸入框,頁面會自動上移
                                        //pan          //若鍵盤蓋住輸入框,頁面不會自動上移
                                        //auto         //默認值,由系統(tǒng)決定如何處理,iOS平臺該字段等同于resize
    softInputBarEnabled:false,          //(可選項)是否顯示鍵盤上方的工具條,布爾型,默認值:true,只iOS有效
    defaultRefreshHeader:''             //(可選項)設(shè)置使用默認下拉刷新類型,取值范圍:pull、swipe
    customRefreshHeader:''              //(可選項)設(shè)置使用自定義下拉刷新模塊的名稱,設(shè)置后可以使用api.setCustomRefreshHeaderInfo方法來使用自定義下拉刷新組件
}

slidToOpenPane:

  • 類型:布爾
  • 默認值:true
  • 描述:(可選項)是否支持在頁面邊緣處滑動打開drawerPane

slidToClosePane:

  • 類型:布爾
  • 默認值:true
  • 描述:(可選項)在打開的drawerPane頁面,是否支持滑動關(guān)閉drawerPane

tapToClosePane:

  • 類型:布爾
  • 默認值:true
  • 描述:(可選項)在打開的drawerPane頁面,是否支持點擊遮罩部分關(guān)閉drawerPane

示例代碼

api.openDrawerLayout({
    name: 'main',
    url: './main.html',
    animation: {
        type: 'none'
    },
    leftPane: {
        name: 'leftPane',
        url: 'leftPane.html'
    }
});

可用性

iOS系統(tǒng),Android系統(tǒng)

可提供的1.2.0及更高版本

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號